From 5eb275b146e6bae87dec5252ef38347b58309d69 Mon Sep 17 00:00:00 2001 From: Nicolas Hernandez Date: Tue, 15 Dec 2020 19:07:31 -0300 Subject: [PATCH] Release candidate Polished the readme, and got rid of unneeded dependency. --- README.md | 33 +++++++++++++++++++++++---------- index.html | 15 +++------------ package.json | 3 +-- 3 files changed, 27 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 7bbf9c9..5f1acf4 100755 --- a/README.md +++ b/README.md @@ -2,18 +2,31 @@ Timer with countdown to control intervals and time lapses in your workouts -## Classes +## Instalation -interval timer (tracks states) -config (configurates the timer) -audio player +Simply grab the latest release from github's [releases page](https://github.com/nicolas-hernandez/interval-timer/releases), +decompress it and run `interval-timer.exe`. -## States +## Development -config +This is esentially an electron app. -rest -work -pause -reset +To run the app: +``` bash +git clone https://github.com/nicolas-hernandez/interval-timer.git +cd interval-timer +npm start +``` + +The tool used to create the windows release is `electron-packager`. +You can generate the release by running: +``` +npm win +``` + +## Roadmap + +- Fix CSS for the pause/reset overlays +- Remember last time's config instead of reversing to the default one. +- Add clock if the app is fullscreen diff --git a/index.html b/index.html index a7a8470..a0c3406 100755 --- a/index.html +++ b/index.html @@ -6,25 +6,20 @@ - - Interval Timer - - - + Interval Timer + - - @@ -84,7 +79,7 @@ Rest
Pause - Reset + Reset @@ -93,8 +88,4 @@ - - - - diff --git a/package.json b/package.json index ea79c6e..9b8daba 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,10 @@ { "name": "intervaltimer", - "version": "1.0.0", + "version": "0.1.0", "description": "Interval timer app", "main": "main.js", "dependencies": { "bootstrap": "^4.5.3", - "bootstrap-material": "^4.1.51", "bootstrap-material-design": "^4.1.3", "jquery": "^3.5.1", "material-icons": "^0.3.1",