diff --git a/doc.go b/doc.go index c9b9901..b83f924 100644 --- a/doc.go +++ b/doc.go @@ -84,7 +84,7 @@ cable or a microcontroller development board) is possible to retrieve the USB metadata, like VID/PID or USB Serial Number, with the GetDetailedPortsList function in the enumerator package: - import "go.bug.st/serial.v1/enumerator" + import "go.bug.st/serial.v1/enumerator" ports, err := enumerator.GetDetailedPortsList() if err != nil { diff --git a/enumerator/doc.go b/enumerator/doc.go new file mode 100644 index 0000000..d214715 --- /dev/null +++ b/enumerator/doc.go @@ -0,0 +1,21 @@ +// +// Copyright 2014-2017 Cristian Maglie. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. +// + +/* +Package enumerator is a golang cross-platform library for USB serial port discovery. + +WARNING: this library is still beta-testing code! please consider the library +and the API as *unstable*. Beware that, even if at this point it's unlike to +happen, the API may be subject to change until this notice is removed from +the documentation. + +This library has been tested on Linux, Windows and Mac and uses specific OS +services to enumerate USB PID/VID, in particular on MacOSX the use of cgo is +required in order to access the IOKit Framework. This means that the library +cannot be easily cross compiled for GOOS=darwing targets. + +*/ +package enumerator // import "go.bug.st/serial.v1/enumerator"