Adds README

moigonzalez · Jan 14, 2019 · fb63f42 · fb63f42
1 parent 23a6dfe
commit fb63f42
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,26 @@
-# PWA Barcode Scanner 🛒
+# PWA Barcode Scanner 🛒
+
+Scan product's barcodes to get its nutritional values 🍎
+
+# Installation
+
+```bash
+npm run install
+```
+
+# Development
+
+```bash
+npm run dev
+```
+
+# Contributing
+
+Please see our [contributing.md](https://github.com/moigonzalez/pwa-barcode-scanner/blob/master/contributing.md)
+
+
+# Open Food Facts
+
+All the information comes from [Open Food Facts](https://world.openfoodfacts.org/discover) Database.
+
+Free and open database of food products from around the world!
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1,9 @@
+
+Contributing to pwa-barcode-scanner
+
+    Fork this repository to your own GitHub account and then clone it to your local device.
+    Install the dependencies: npm install
+    Run npm run dev to watch changes from /src
+    Open a PR with your changes :)
+    Each PR will create a netlify staging url
+    Have fun!
diff --git a/src/index.html b/src/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <title>PWA Barcode Scanner </title>
+  <title>PWA Barcode Scanner 🛒</title>
   <meta name="description" content="Check food nutritional values scanning the barcode">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <meta name="theme-color" content="#333333">