update readme

lexndru · Apr 30, 2019 · 7499388 · 7499388
1 parent 5cef382
commit 7499388
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@ tmp/
 dist/
 node_modules/
 .notes
+.desktop
 package-lock.json
+BacklogApp-linux-x64
diff --git a/.npmignore b/.npmignore
@@ -1,2 +1,6 @@
+dist/
+tmp/
 node_modules/
 package-lock.json
+.desktop
+BacklogApp-linux-x64
diff --git a/README.md b/README.md
@@ -1,7 +1,15 @@
 # Backlog Application
-Another to-do list application.
+Another to-do list application to take notes, write ideas, mark them as done, save and edit later.
 
-![alt text](https://raw.githubusercontent.com/lexndru/backlog-app/master/screenshot.png)
+![application screens](https://raw.githubusercontent.com/lexndru/backlog-app/master/screenshot.png)
+
+## Install from sources
+```
+$ npm install .
+$ npm run build
+$ cd dist # e.g. cd BacklogApp-linux-x64
+$ ./BacklogApp
+```
 
 ## License
 Copyright (c) 2019 Alexandru Catrina

diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
  "test": "standard",
  "setup": "classjar -s com/bean/note.json -d com/class",
  "start": "electron .",
- "build": "electron-packager . BacklogApp -icon=img/icon -platform=all -arch=all -version=1.0.0 -asar"
+ "build": "electron-packager . BacklogApp"
  },
  "bin": {
  "backlog": "index.js"

diff --git a/screenshot.png b/screenshot.png