airgradienthq/arduino
1
0
Fork 1
mirror of https://github.com/airgradienthq/arduino.git synced 2025-09-25 20:20:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Link to inner docs pages from main README

Browse Source 
Fixes #335

There's useful documentation in the docs/ directory, but it's hard for users to discover it, as there are no links to it.

This change updates the README to add links to the inner docs pages for users interested in customizing and re-flashing firmware onto their devices as well as understanding the OTA update system.
This commit is contained in:
Michael Lynch
2025-08-12 20:08:29 -04:00
parent d8eb6b3c1a
commit ce0af5bf60
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -24,9 +24,18 @@ If you have an older version of the AirGradient PCB not mentioned in the example
If you have any questions or problems, check out [our forum](https://forum.airgradient.com/). If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).
## Documentation ## Development
Local server API documentation is available in [/docs/local-server.md](/docs/local-server.md) and AirGradient server API on [https://api.airgradient.com/public/docs/api/v1/](https://api.airgradient.com/public/docs/api/v1/). * See [compilation instructions](/docs/local-server.md) for details about how to customize AirGradient's firmware and flash it to your device.
## Over the air (OTA) updates
* See the [OTA Updates documentation](/docs/ota-updates.md) for details about how AirGradient monitors receive over the air updates.
## API documentation
* [Local server API documentation](/docs/local-server.md)
* [AirGradient Cloud server API documentation](https://api.airgradient.com/public/docs/api/v1/).
## The following libraries have been integrated into this library for ease of use ## The following libraries have been integrated into this library for ease of use