Add readme

JaceHensley · Oct 20, 2017 · b4bb500 · b4bb500
1 parent bfc2cee
commit b4bb500
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Verter
+
+> Chrome extension for viewing Vertcoin price in various currencies
+
+![image](/assets/screenshot.png)
+
+## Building
+
+1. Set up Dart if you haven't yet
+  - https://webdev.dartlang.org/guides/get-started
+2. Check out the OverReact package, this extension uses it.
+  - https://workiva.github.io/over_react/
+3. Make changes to Dart files
+4. Test it with dartium
+  - pub serve --web-compiler=none
+5. Build it `./tool/build.sh`
+6. Pack it through chrome
diff --git a/assets/screenshot.png b/assets/screenshot.png