lechu/go-serial
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates to readme

Browse Source
This commit is contained in:
Cristian Maglie
2019-12-02 20:00:32 +01:00
parent df95023074
commit f2a9ea925f
1 changed files with 4 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -1,4 +1,4 @@
[![Build Status](https://travis-ci.org/bugst/go-serial.svg?branch=v1)](https://travis-ci.org/bugst/go-serial)
[![Build Status](https://travis-ci.org/bugst/go-serial.svg?branch=master)](https://travis-ci.org/bugst/go-serial)
# go.bug.st/serial
@@ -8,24 +8,11 @@ A cross-platform serial library for go-lang.
See the godoc here: https://godoc.org/go.bug.st/serial
## Development
## go.mod transition
If you want to contribute to the development of this library, you must clone this git repository directly into your `src` folder under `src/go.bug.st/serial` and checkout the branch `v1`.
This library now support `go.mod` with the import `go.bug.st/serial`.
```
cd $GOPATH
mkdir -p src/go.bug.st/
git clone https://github.com/bugst/go-serial.git -b v1 src/go.bug.st/serial
go test go.bug.st/serial
```
## What's new in v1
There are some API improvements, in particular object naming is now more idiomatic, class names are less redundant (for example `serial.SerialPort` is now called `serial.Port`), some internal class fields, constants or enumerations are now private and some methods have been moved into the proper interface.
If you come from the version v0 and want to see the full list of API changes, please check this pull request:
https://github.com/bugst/go-serial/pull/5/files
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.
## License