created README

Raisess · Aug 22, 2020 · 535e1ff · 535e1ff
1 parent 6822327
commit 535e1ff
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# 🤠 RANDOM HASH GENERATOR
+
+## ⚙️ CONFIGURATION
+
+- You need the gcc and nodejs (to use npm) installed.
+
+## 🔌 INSTALLING
+
+Clone the repo, go to repo folder and then:
+
+```shell
+npm run compile
+```
+
+## 🔮 RUNNING
+
+```shell
+npm run start
+```
+
+## 🧹 CLEANING BUILD
+
+To make this you need the project compiled before.
+
+Run this command:
+
+```shell
+npm run clean
+```
+