more readme updates for the API

This commit is contained in:
Jason Calabrese
2015-08-27 23:39:00 -07:00
parent d612cff37a
commit 63ed06f337
+11 -5
View File
@@ -53,12 +53,12 @@ Community maintained fork of the
- [Updating my version?](#updating-my-version)
- [What is my mongo string?](#what-is-my-mongo-string)
- [Configure my uploader to match](#configure-my-uploader-to-match)
- [Nightscout API](#nightscout-api)
- [Environment](#environment)
- [Required](#required)
- [Features/Labs](#featureslabs)
- [Core](#core)
- [Predefined values for your browser settings (optional)](#predefined-values-for-your-browser-settings-optional)
- [Nightscout API](#nightscout-api)
- [Plugins](#plugins)
- [Default Plugins](#default-plugins)
- [Built-in/Example Plugins:](#built-inexample-plugins)
@@ -111,6 +111,16 @@ mongo string. You can copy and paste the text in the gray box into your
Use the [autoconfigure tool][autoconfigure] to sync an uploader to your config.
## Nightscout API
The Nightscout API enables direct access to your DData without the need for direct Mongo access.
You can find CGM data in `/api/v1/entries`, Care Portal Treatments in `/api/v1/treatments`, and Treatment Profiles in `/api/v1/profile`.
The server status and settings are available from `/api/v1/status.json`.
Also, by using Swagger you can also generate client code to make working with the Nightscout API.
After deploying your site, you can learn more about the Nightscout API looking at https://YOUR-SITE.com/api-docs.html or reviewing [swagger.yaml](swagger.yaml).
## Environment
`VARIABLE` (default) - description
@@ -161,10 +171,6 @@ Use the [autoconfigure tool][autoconfigure] to sync an uploader to your config.
* `SHOW_PLUGINS` - enabled plugins that should have their visualizations shown, defaults to all enabled
* `LANGUAGE` (`en`) - language of Nighscout. If not available english is used
### Nightscout API
After deploying your site, you can learn more about the Nightscout API looking at https://YOUR-SITE.com/api-docs.html or reviewing [swagger.yaml](swagger.yaml).
### Plugins
Plugins are used extend the way information is displayed, how notifications are sent, alarms are triggered, and more.