Add readme

Vopaaz · Nov 24, 2019 · e4bae09 · e4bae09
1 parent 9b3b5aa
commit e4bae09
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,13 +5,30 @@ Vocabulary builder simulating using a textbook and tear-it-down methodology.
 - [Vocab-Vanquisher](#vocab-vanquisher)
   - [Demo](#demo)
   - [Installation](#installation)
+    - [Windows Executable](#windows-executable)
+    - [Run from Source](#run-from-source)
   - [Methodology](#methodology)
   - [Road Map](#road-map)
 
 ## Demo
 
+![Demo](pics/demo.gif)
+
 ## Installation
 
+### Windows Executable
+
+Download the release
+
+### Run from Source
+
+```bash
+git clone git@github.com:Vopaaz/Vocab-Vanquisher.git
+cd Vocab-Vanquisher
+npm install
+npm run electron:serve
+```
+
 ## Methodology
 
 Most vocabulary builder applications today ask you to choose

diff --git a/pics/demo.gif b/pics/demo.gif