Skip to content

Commit

Permalink
Add link to documentation (live when public; self-hostable)
Browse files Browse the repository at this point in the history
  • Loading branch information
momer committed May 3, 2024
1 parent 28bcb3e commit 67998b9
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,24 @@

![Bonsai | Fully Managed Elasticsearch & OpenSearch](doc/assets/bonsai.png)

This is the Go API Client for [Bonsai](https://bonsai.io/)
This is the Go API Client for [Bonsai Cloud](https://bonsai.io/) - The only
managed Elasticsearch, OpenSearch, and SolrCloud platform that provides the
support of a search engineering team, but at a fraction of the cost!

## Documentation

Full documentation is available on godoc at https://pkg.go.dev/github.com/omc/bonsai-api-go/v1/bonsai/

### Self-hosting the docs

1. Install [godoc](https://pkg.go.dev/golang.org/x/tools/cmd/godoc)
```shell
go install golang.org/x/tools/cmd/godoc@latest
```
2. Run `godoc` from the project's root directory:
```shell
godoc -http:6060
```
## Installation
Expand Down

0 comments on commit 67998b9

Please sign in to comment.