Update README.md

codeferreira · Aug 28, 2019 · 387c8ed · 387c8ed
1 parent 94344ad
commit 387c8ed
Showing 1 changed file with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,22 @@
-# YelpCamp
-A Website that shows Campsites made with Node.JS
+# <center> YelpCamp</center>
 
-It is my personal project to learn Node.JS and other technologies like: Bootstrap, EJS, MongoDB, etc.
+Yelpcamp is a campsite evaluator where you can see campsite reviews before you plan your next camping trip.
+
+## Tech
+
+Yelpcamp is a personal project to learn more about JavaScript and mainly about [Node.JS](https://nodejs.org/en/).
+
+- NodeJS (Server)
+- Bootstrap
+- EJS (Engine View)
+- MongoDB (Database)
+- Heroku (Deploy)
+
+## Instalation
+
+To install this project is simple, just follow the steps below.
+
+1. Clone the repositorie into you machine. `git clone https://github.com/JKFher/yelpcamp.git`
+2. Into the folder install the dependencies. `yarn` or `npm install`
+3. Run the application. `yarn start` or `npm start`
+4. Have fun!