Skip to content

Commit

Permalink
chore(readme): Update sdk godoc reference
Browse files Browse the repository at this point in the history
Docs are now available on pkg.go.dev. This was already covered with
a badge but helpful if the SDK installation instructions have
it updated too.
  • Loading branch information
ditsuke committed May 7, 2022
1 parent 36bc853 commit 4f13310
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ binary. With the latter, you would be able to use Swagger to generate SDKs for o

### SDK

Install the library using `go get github.com/ditsuke/amizone-go`. Usage is well documented go docs, and docs
are due to be published soon.
Install the library using `go get github.com/ditsuke/amizone-go`. The public API is well documented through godocs,
easily accessed on [pkg.go.dev][go-reference] or [godocs.io][godocs.io].

### API Server

Expand Down Expand Up @@ -74,3 +74,6 @@ library in your own project! If you're working or planning to work on one, I wou
[go-report-card]: https://goreportcard.com/report/github.com/ditsuke/go-amizone

[heroku]: https://www.heroku.com/

[godocs.io]: https://godocs.io/github.com/ditsuke/go-amizone

0 comments on commit 4f13310

Please sign in to comment.