Add link to documentation (lve when public; self-hostable)

omc · May 3, 2024 · 966083c · 966083c
1 parent c0aad80
commit 966083c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,26 @@
 # bonsai-api-go: Bonsai Cloud Go API Client
 
+![Bonsai | Fully Managed Elasticsearch & OpenSearch](doc/assets/bonsai.png)
+
+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
 
 ```shell

diff --git a/doc/assets/bonsai.png b/doc/assets/bonsai.png