Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sstallion committed Jul 16, 2023
1 parent 364f6dd commit d92b111
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [0.8.0] - 2022-12-18

Historical release based on the original HIDAPI, updated to support Go Modules.
See https://github.com/signal11/hidapi for more details.
See https://github.com/signal11/hidapi for details.

[Unreleased]: https://github.com/sstallion/go-hid/compare/v0.14.1...HEAD
[0.14.1]: https://github.com/sstallion/go-hid/releases/tag/v0.14.1
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ don't have time to contribute!

## Making Changes

> **Note**: This guide assumes you have a working Go 1.17 or later installation.
> **Note**: This guide assumes you have a working Go 1.17 (or later)
> installation.
To get started, [fork][2] this repository on GitHub and clone a working copy for
development:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To add package `hid` as a dependency or upgrade to its latest version, issue:
$ go get github.com/sstallion/go-hid@latest

>**Note**: Prerequisites for building HIDAPI from source must be installed prior
> to issuing `go get`. See [Prerequisites][6] for more details.
> to issuing `go get`. See [Prerequisites][6] for details.
### libusb Backend Support

Expand All @@ -48,12 +48,12 @@ doc` command after installation:

## Contributing

Pull requests are welcome! See [CONTRIBUTING.md][7] for more details.
Pull requests are welcome! See [CONTRIBUTING.md][7] for details.

## License

Source code in this repository is licensed under a Simplified BSD License. See
[LICENSE][5] for more details.
[LICENSE][5] for details.

[1]: https://github.com/sstallion/go-hid/actions/workflows/ci.yml
[2]: https://pkg.go.dev/github.com/sstallion/go-hid
Expand Down

0 comments on commit d92b111

Please sign in to comment.