Skip to content

Commit 7179dae

Browse files
umbynoscmaglie
authored andcommitted
adapt README.md (links not working)
1 parent a3a6924 commit 7179dae

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
# A golang library to handle the Arduino pluggable-monitor communication protocol.
1+
# Pluggable Monitor Protocol Handler
22

3-
## How to build
3+
<!-- NOTE: update the pkg.go.dev badge URL on each major release -->
4+
5+
[![Go Reference](https://pkg.go.dev/badge/github.com/arduino/pluggable-monitor-protocol-handler.svg)](https://pkg.go.dev/github.com/arduino/pluggable-monitor-protocol-handler/)
6+
7+
This project is a library to ease implementation of pluggable discoveries for the [Arduino CLI](https://github.com/arduino/arduino-cli)
8+
following the [official specification](https://arduino.github.io/arduino-cli/latest/platform-specification/#pluggable-monitor).
9+
10+
## Reference implementation
11+
12+
The [`dummy-monitor` folder](dummy-monitor) contains a reference pluggable monitor implementation.
413

514
## Security
615

716
If you think you found a vulnerability or other security-related bug in this project, please read our
8-
[security policy](https://github.com/arduino/serial-discovery/security/policy) and report the bug to our Security Team 🛡️
17+
[security policy](https://github.com/arduino/serial-monitor/security/policy) and report the bug to our Security Team 🛡️
918
Thank you!
1019

1120
e-mail contact: [email protected]
@@ -15,7 +24,7 @@ e-mail contact: [email protected]
1524
Copyright (c) 2021 ARDUINO SA (www.arduino.cc)
1625

1726
The software is released under the GNU General Public License, which covers the main body
18-
of the serial-discovery code. The terms of this license can be found at:
27+
of the serial-monitor code. The terms of this license can be found at:
1928
https://www.gnu.org/licenses/gpl-3.0.en.html
2029

21-
See [LICENSE.txt](https://github.com/arduino/serial-discovery/blob/master/LICENSE.txt) for details.
30+
See [LICENSE.txt](https://github.com/arduino/serial-monitor/blob/master/LICENSE.txt) for details.

go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ module github.com/arduino/pluggable-monitor-protocol-handler
22

33
go 1.16
44

5+
require github.com/arduino/go-properties-orderedmap v1.4.0

0 commit comments

Comments
 (0)