From 67998b906b74ef0e651233ac28f82035c68527be Mon Sep 17 00:00:00 2001 From: Mo Omer Date: Fri, 3 May 2024 16:39:27 -0500 Subject: [PATCH] Add link to documentation (live when public; self-hostable) --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c9194b7..b98d65c 100644 --- a/README.md +++ b/README.md @@ -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