Add readme file.

elszczepano · Jul 18, 2019 · 7ad7bc8 · 7ad7bc8
1 parent fff72d2
commit 7ad7bc8
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.MD b/README.MD
@@ -0,0 +1,17 @@
+# Find Mates API
+
+A simple REST API written in Node.js and Express.js.
+
+## How to run
+
+Execute `npm run dev` command in the console.
+
+## How to build
+
+Execute `npm run build` in the console.
+
+## Other useful commands 
+
+Execute `npm t` or `npm run test` to run unit tests.
+Execute `npm run lint` to enable linting.
+Execute `npm run seed` to run seeders.