From f2a9ea925f9c8efabacd3d4e6ee854f18017aa14 Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Mon, 2 Dec 2019 20:00:32 +0100 Subject: [PATCH] Updates to readme --- README.md | 21 ++++----------------- 1 file changed, 4 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b25130f..79b2110 100644 --- a/README.md +++ b/README.md @@ -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