Release candidate

Polished the readme, and got rid of unneeded dependency.
nicolas-hernandez · Dec 15, 2020 · 5eb275b · 5eb275b
1 parent de7d501
commit 5eb275b
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 24 deletions.
diff --git 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
@@ -6,25 +6,20 @@
     <meta name="description" content="Interval timer">
     <meta name="keywords" content="interval timer, timer, tabata, chronometer, chrono" />
     <meta name="author" content="Nicolas Hernandez" /> 
-
-    <title>Interval Timer</title>
-
 	<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-
   	<meta name="theme-color" content="#CCC">
 
-	<link rel="icon" href="img/icon.png">
+    <title>Interval Timer</title>
 
+	<link rel="icon" href="img/icon.png">
 	<link rel="stylesheet" href="node_modules/material-icons/css/material-icons.min.css">  
 	<link rel="stylesheet" href="node_modules/bootstrap-material-design/dist/css/bootstrap-material-design.min.css">  
 	<link rel="stylesheet" href="css/framework.css">  
     <!-- <link rel="manifest" href="./manifest.json"> -->
-
 </head>
 
 <body>
 
-	<!-- <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> -->
 	<nav class="navbar navbar-dark bg-dark fixed-top justify-content-md-center">
         <a class="navbar-brand" href="#"><img src="img/icon.png" alt="icon" height="24"> Interval Timer</a>
 	</nav>
@@ -84,7 +79,7 @@
 			<span id="textChrono">Rest</span>
 			<div class="clear"></div>
 			<a id="pause" class="btn btn-a btn-sm navigatorChrono" tabindex="0">Pause</a>
-			<a id="reset" class="btn btn-c btn-sm navigatorChrono" tabindex="0">Reset</a> <!-- pause and confirm -->
+			<a id="reset" class="btn btn-c btn-sm navigatorChrono" tabindex="0">Reset</a>
 		</div>
 	</div>
 
@@ -93,8 +88,4 @@
 	</video>
     <script type="module" charset="utf-8" src="js/app.js"></script>
 </body>
-<!-- <script src="node_modules/popper.js/dist/popper.min.js"></script> -->
-<!-- <script src="node_modules/jquery/dist/jquery.slim.min.js"></script> -->
-<!-- <script src="node_modules/bootstrap-material-design/dist/js/bootstrap-material-design.min.js"></script> -->
-<!-- <script>$(document).ready(function() { $('body').bootstrapMaterialDesign(); });</script> -->
 </html>
diff --git 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",