Skip to content

Commit ce0af5b

Browse files
committed
Link to inner docs pages from main README
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.
1 parent d8eb6b3 commit ce0af5b

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,18 @@ If you have an older version of the AirGradient PCB not mentioned in the example
2424

2525
If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).
2626

27-
## Documentation
27+
## Development
2828

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/).
3039

3140
## The following libraries have been integrated into this library for ease of use
3241

0 commit comments

Comments
 (0)