Have a README.

rantomizer · Jul 7, 2016 · 4c5e995 · 4c5e995
1 parent b3d8682
commit 4c5e995
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# Scanner
+
+Renders your page within Electron then performs an adblock scan on it.
+
+Requires node and npm.  Node 6 is recommended.
+
+## How to use
+
+After cloning the repo:
+
+    npm install
+    ./bin/scan URL