added example gif to readme

Almenon · Jan 17, 2018 · 7f58c49 · 7f58c49
1 parent 1890fcd
commit 7f58c49
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,16 @@
-a VScode extension for AREPL
+## AREPL: now a vscode edition
 
-automatically evaluates python code in real-time as you type
+AREPL automatically evaluates python code in real-time as you type
+
+Contact me to get the beta release!
+
+![Alt Text](https://raw.githubusercontent.com/Almenon/AREPL-vscode/master/example.gif)
+
+#### Deveveloper Setup:
+
+1. Install python 3 and npm (if not already installed)
+2. clone this repository
+3. npm install
+4. start debugging
+
+see [AREPL-backend](https://github.com/Almenon/AREPL-backend) for the npm package that executes the python code
diff --git a/example.gif b/example.gif