diff --git a/README.md b/README.md index 5f59173..6702571 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# PWA Barcode Scanner 🛒 \ No newline at end of file +# 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 new file mode 100644 index 0000000..f30548e --- /dev/null +++ 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 index 56e6335..cd63518 100644 --- a/src/index.html +++ b/src/index.html @@ -3,7 +3,7 @@ - PWA Barcode Scanner + PWA Barcode Scanner 🛒