add readme

README.md

@@ -0,0 +1,98 @@
+<h1 align="center">
+  LixAttendance
+</h1>
+
+<p align="center">
+  <a href="#description">Description</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#requirements">Requirements</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#technologies">Technologies</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#usage">Usage</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#demonstration">Demonstration</a>
+</p>
+<br />
+<p align="center">
+  <img src="https://img.shields.io/static/v1?label=license&message=MIT" alt="License">
+  <img src="https://img.shields.io/github/repo-size/Lissone/lix-attendance" alt="Repo size" />
+  <img src="https://img.shields.io/github/languages/top/Lissone/lix-attendance" alt="Top lang" />
+  <img src="https://img.shields.io/github/stars/Lissone/lix-attendance" alt="Stars repo" />
+  <img src="https://img.shields.io/github/forks/Lissone/lix-attendance" alt="Forks repo" />
+  <img src="https://img.shields.io/github/issues-pr/Lissone/lix-attendance" alt="Pull requests" >
+  <img src="https://img.shields.io/github/last-commit/Lissone/lix-attendance" alt="Last commit" />
+</p>
+
+<p align="center">
+  <a href="https://github.com/Lissone/lix-attendance/issues">Report bug</a>
+  ·
+  <a href="https://github.com/Lissone/lix-attendance/issues">Request feature</a>
+</p>
+
+<br />
+
+## Description
+
+Project developed with the intention of getting deeper into WS requests and real-time applications. It consists of a messaging chat for a parent application, which can choose to enable or disable this type of support chat. Developed at the Next Level Week 5 (NLW) marathon, taught by Daniela Leão, from April 19th to 25th, 2021.
+
+## Requirements
+
+* [Yarn](https://yarnpkg.com/)
+* [Nodejs](https://nodejs.org/en/)
+
+## Technologies
+
+### Backend (Api)
+* NodeJs
+* Typescript
+* Express
+* Socket.io
+* TypeORM
+* Sqlite
+* ESLint
+
+### Front End
+* Html
+* Css
+* Javascript
+* Ejs
+
+## Usage
+
+You can use this project as a template for another one, or clone it on your pc using the command:
+
+```bash
+git clone https://github.com/Lissone/lix-attendance.git
+cd lix-attendance
+```
+
+Install dependencies using:
+```bash
+yarn
+#or
+npm run
+```
+
+Need to add environment variables in both projects:
+```bash
+# .\.env
+PORT=5000
+```
+
+Run application:
+```bash
+yarn dev
+#or
+npm run dev
+```
+
+## Demonstration
+
+<img src="./.github/demo-lix-attendance.gif" alt="Demo LixAttendance" width="100%" height="100%"/>
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+<h4 align="center">
+  Made with ❤️ by <a href="https://github.com/Lissone" target="_blank">Lissone</a>
+</h4>
+
+<hr />