diff --git a/apps/burn/ChangeLog b/apps/burn/ChangeLog index 5560f00bc..e617d1ee3 100644 --- a/apps/burn/ChangeLog +++ b/apps/burn/ChangeLog @@ -1 +1,2 @@ 0.01: New App! +0.02: Added README.md diff --git a/apps/burn/README.md b/apps/burn/README.md new file mode 100644 index 000000000..5a32609ba --- /dev/null +++ b/apps/burn/README.md @@ -0,0 +1,29 @@ +# Burn: Calorie Counter + +Burn is a calorie counter application for Bangle.js (Espruino). It is based on the original Counter app and has been enhanced with additional features. + +## Features + +- **Persistent counter**: The counter value is saved to a file, so it persists even when the app is closed or the device is restarted. +- **Daily reset**: The counter resets each day, allowing you to track your calorie intake on a daily basis. +- **Adjustable increment value**: You can adjust the increment value to suit your needs. + +## Controls + +### Bangle.js 1 + +- **BTN1**: Increase (or tap right) +- **BTN3**: Decrease (or tap left) +- **Press BTN2**: Change increment + +### Bangle.js 2 + +- **Swipe up**: Increase +- **Swipe down**: Decrease +- **Press BTN**: Change increment + +## How it Works + +The counter value and the date are stored in a file named "kcal.txt". The counter value is read from the file when the app starts and written to the file whenever the counter value is updated. + +The app uses the current date to determine whether to reset the counter. If the date has changed since the last time the counter was updated, the counter is reset to 0. diff --git a/apps/burn/metadata.json b/apps/burn/metadata.json index 576d6ef9e..7555c3632 100644 --- a/apps/burn/metadata.json +++ b/apps/burn/metadata.json @@ -1,10 +1,11 @@ { "id": "burn", "name": "Burn", - "version": "0.01", - "description": "Calorie Counter", + "version": "0.02", + "description": "Simple Calorie Counter -- saves to flash and resets at midnight", "icon": "burn_icon.png", "tags": "tool", + "readme":"README.md", "supports": ["BANGLEJS", "BANGLEJS2"], "screenshots": [{"url":"bangle1-burn-screenshot.png"}], "allow_emulator": true,