Update README with media, add keywords, ignore releases.

robmcelhinney · May 6, 2020 · cb6daf6 · cb6daf6
1 parent 61674b5
commit cb6daf6
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -11,6 +11,7 @@
 
 # production
 /client/build
+/release
 
 # misc
 .DS_Store

diff --git a/README.md b/README.md
@@ -22,6 +22,12 @@ Must be on same WiFi.
     $ cd /dir/to/share
     $ qr-file-share
 
+## Demo
+![screenshot of program running from command line](demo/screenshot.png)
+![screenshot of web interface on mobile](demo/mobile_screenshot.png)
+![Phone using camera to detect qr code](demo/sample.gif)
+
+
 ## Start & watch
 
     $ npm start

diff --git a/demo/mobile_screenshot.png b/demo/mobile_screenshot.png
diff --git a/demo/sample.gif b/demo/sample.gif
diff --git a/demo/screenshot.png b/demo/screenshot.png
diff --git a/package.json b/package.json
@@ -44,5 +44,13 @@
     "assets": [
       "client/build/**"
     ]
-  }
+  },
+  "keywords": [
+    "qr",
+    "share",
+    "WiFi",
+    "terminal",
+    "file",
+    "share"
+  ]
 }