Skip to content

Commit

Permalink
docs(readme): Add features and installation sections
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe565 committed May 8, 2024
1 parent 76f0a17 commit 585ea2b
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ A Nightscout plugin for the Elgato Stream Deck.
<p align="center">
<img src="./assets/preview.svg" title="Nightscout Preview Image" align="center" width="100"/>
</p>

## Features

- Displays current blood sugar reading, change since last reading, and an arrow
- Supports mg/dL and mmol/L
- Supports Nightscout API tokens
- Only requests new data when a new reading should be available, which gives timely data while also conserving battery life

## Installation

### Manual Installation

- Download the latest plugin release [here](https://github.com/gabe565/streamdeck-nightscout/releases/latest)
- Open downloaded `.sdplugin` file. It will be automatically installed to your Stream Deck application.

0 comments on commit 585ea2b

Please sign in to comment.