You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,9 +24,18 @@ If you have an older version of the AirGradient PCB not mentioned in the example
24
24
25
25
If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).
26
26
27
-
## Documentation
27
+
## Development
28
28
29
-
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/).
29
+
* See [compilation instructions](/docs/local-server.md) for details about how to customize AirGradient's firmware and flash it to your device.
30
+
31
+
## Over the air (OTA) updates
32
+
33
+
* See the [OTA Updates documentation](/docs/ota-updates.md) for details about how AirGradient monitors receive over the air updates.
34
+
35
+
## API documentation
36
+
37
+
*[Local server API documentation](/docs/local-server.md)
38
+
*[AirGradient Cloud server API documentation](https://api.airgradient.com/public/docs/api/v1/).
30
39
31
40
## The following libraries have been integrated into this library for ease of use
0 commit comments