From 42d05ab7ab1ce08693643ef695ac0e931bb150fe Mon Sep 17 00:00:00 2001
From: Alexandra <bug.graph@gmail.com>
Date: Mon, 14 Feb 2022 23:54:58 +0100
Subject: [PATCH] chore: setup README

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index e69de29..c8ebe71 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,29 @@
+# smash-or-pass
+
+Simple Smash or pass created with React.
+Available with Pokemon list for now.
+
+
+### Environment Variables
+
+If you want to change environment variables, you just have to modify the config file found in `public/env/Config.js`
+
+### Husky
+
+if you want to enable a pre-commit hook for `prettier` and `eslint` with `husky`, run the following commands
+
+```bash
+$ cd projectRoot
+$ npx husky install
+```
+
+
+To run the react app locally using npm, run the following commands
+
+```bash
+$ cd projectRoot
+$ npm install
+$ npm start
+$ npx json-server --watch db.json --port 8080
+```
+