write readme

pull/507/head
Bastian Greshake Tzovaras 2020-06-17 13:55:39 +02:00
parent f339375a8e
commit 087e21b4af
2 changed files with 12 additions and 8 deletions

View File

@ -1,25 +1,29 @@
# Widget Name
# The One Button tracker
Describe the app...
A simple widget that turns the `BTN1` of your Bangle.js into a one-button-tracker that can be used right from the clock face. Record when you're sneezing, yawning, eating, or whatever you think the button should track for you.
Add screen shots (if possible) to the app folder and link then into this file with ![](<name>.png)
![](one-button.GIF)
## Usage
Describe how to use it
Every time you press & release the `BTN1` from the clockface this widget will record the time you pressed & released. While you press the button the Bangle will briefly vibrate and the green LED in the display will light up while you're keeping the button pressed.
Once you release `BTN1` both the start & end time of your button press will be saved in 2-column `one_button_presses.csv` CSV file on your _Bangle.js_. The CSV file can [be downloaded from the _My Apps_ tab on the Bangle.js app store](https://banglejs.com/apps/).
## Features
Name the function
- Track whatever events you want with a simple button press on your wrist
- Track multiple things with a single button by using different length of button presses
- Easily export the data to visualize your presses in a tool of your choice
## Controls
Name the buttons and what they are used for
Only makes use of `BTN1` (the top one) right now.
## Requests
Name who should be contacted for support/update requests
[Reach out to Bastian](https://www.github.com/gedankenstuecke) if you have feature requests or notice bugs.
## Creator
Your name
Made by [Bastian Greshake Tzovaras](https://tzovar.as), inspired by the one-button tracker project by Thomas Blomseth Christiansen and Jakob Eg Larsen.

BIN
apps/1button/one-button.GIF Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB