Merge pull request #188 from twpayne/doc-fixes

Fixed minor documentation typos
This commit is contained in:
Cristian Maglie
2024-06-24 17:25:22 +02:00
committed by GitHub

View File

@@ -2,17 +2,17 @@
# go.bug.st/serial
A cross-platform serial library for go-lang.
A cross-platform serial port library for Go.
## Documentation and examples
See the godoc here: https://godoc.org/go.bug.st/serial
See the package documentation here: https://pkg.go.dev/go.bug.st/serial
## go.mod transition
This library now support `go.mod` with the import `go.bug.st/serial`.
This library supports `go.mod` with the import `go.bug.st/serial`.
If you came from the pre-`go.mod` era please update your import paths from `go.bug.st/serial.v1` to `go.bug.st/serial` to receive new updates. Anyway, the latest `v1` release should still be avaiable using the old import.
If you came from the pre-`go.mod` era please update your import paths from `go.bug.st/serial.v1` to `go.bug.st/serial` to receive updates. The latest `v1` release is still available using the old import path.
## Credits
@@ -20,7 +20,7 @@ If you came from the pre-`go.mod` era please update your import paths from `go.b
## License
The software is release under a [BSD 3-clause license]
This software is released under the [BSD 3-clause license].
[contributors]: https://github.com/bugst/go-serial/graphs/contributors
[BSD 3-clause license]: https://github.com/bugst/go-serial/blob/master/LICENSE