docs: update readme

dariusbakunas · Jan 13, 2023 · fb27efa · fb27efa
1 parent 330e867
commit fb27efa
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
 # Go API client for truenas
 
+Go SDK for interacting with TrueNAS APIs (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+## Overview
+
+This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
+
+## TrueNAS Releases
+
 * [angelfish](./angelfish/readme.md)
diff --git a/angelfish/README.md b/angelfish/README.md
@@ -22,7 +22,7 @@ go get golang.org/x/net/context
 Put the package under your project folder and add the following in import:
 
 ```golang
-import angelfish "github.com/dariusbakunas/truenas-go-sdk"
+import angelfish "github.com/dariusbakunas/truenas-go-sdk/angelfish"
 ```
 
 To use a proxy, set the environment variable `HTTP_PROXY`: