github/go-unifi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add detailed usage documentation together with examples (#29)

Browse Source 
* feat: rename Pass to Password in ClientConfig

* docs: add more detailed usage documentation together with examples

* chore: update issue templates

* docs: add codeowners, code of conduct and contributing docs

* chore: add editorconfig

* chore: apply linter
This commit is contained in:
Mateusz Filipowicz
2025-02-18 22:36:08 +01:00
committed by GitHub
parent 5b32a4763e
commit 35e7b2c3cc
16 changed files with 1177 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/readme.md Normal file
View File

@@ -0,0 +1,15 @@
# UniFi Client Documentation - Overview
Welcome to the in-depth documentation for the UniFi Go SDK client.
This client provides a robust, strongly-typed interface to interact with the UniFi Network Controller API,
leveraging auto-generated models and manual enhancements for undocumented endpoints.
## Table of Contents
- [Overview](readme)
- [Getting Started](getting_started.md)
- [Client Configuration](configuration.md)
- [Usage Examples](usage_examples.md)
- [Advanced Topics](advanced_topics.md)
Each section is designed to help you understand and effectively utilize the UniFi client in your Go projects.