summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c58927
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Snappy
+Take screenshots of web pages and also verify that the pages are not blank
+
+## Setup
+```
+npm i
+```
+
+## Tool Usage
+To get a list of possible arguments
+```
+node snappy.js -h
+```
+
+## Example Usage
+```
+node snappy.js -i myWebsites.lst
+``` \ No newline at end of file