diff --git a/README.md b/README.md index 15647d1..52e53b5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # Chat A simple realtime chat website. Made with JavaScript, Socket.io and Bootstrap + +### Requirements + +- [Node](https://nodejs.org/en/) + +### Instalation + +After clone the repository, install the dependencies using: + +`npm install` + +### Starting the server + +`npm start` + +### Contributing + +Anyone can submit a pull request and improve the project. New features comes soon. + +### Author + +Guilherme Werner + +### Liscence + +This project is licensed under the MIT License.