Merge pull request #9 from pgerke/pg-142-documentation

[PG-142] API Client Library Documentation
pgerke · May 14, 2022 · e0b7dae · e0b7dae
2 parents 3a9c4b1 + 707af4d
commit e0b7dae
Show file tree

Hide file tree

Showing 65 changed files with 4,128 additions and 440 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,8 @@ npm install --save freeathome-local-api-client
 
 ## Documentation
 
-A sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample.
+The client library is documented using JSDoc, the generated documentation is available at https://pgerke.github.io/freeathome-local-api-client/.
+There is also a sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample.
 
 ## I found a bug, what do I do?