Merge pull request #28 from GedeonTS/update-readme

This pull request contains the readme update

README.md

@@ -1 +1,104 @@
-# kanban-board
+
+
+![](https://img.shields.io/badge/Microverse-blueviolet)
+
+# Movie-website
+
+## Description
+   | Desktop Version                                           |
+| --------------------------------------------------------- |
+| ![Screenshot from 2022-05-21 08-24-45](https://user-images.githubusercontent.com/97834160/169639118-c87604e7-725b-4d11-a69a-d9cd30c719ea.png) |
+
+> "Movie-website" is a website which display movies from TVmaze api allowing users to like and comment. It keeps record of the users actions by counting likes and comments, saving them to an external server. We are building this website with Javascript (ES6) and Webpack, using promises and async awaits and multiple apis.
+
+### Built With
+
+- Javascript
+- HTML and CSS
+- WEBPACK
+- NPM
+- VS CODE
+
+
+### Getting Started
+
+You can have a copy of this repo run on your local machine by just directly cloning it.
+
+### Live Demo
+
+<!-- Click [here](https://gedeonts.github.io/......./)! -->
+Coming Soon! 🔥
+
+### Prerequisites
+
+- Node.js
+- npm
+- vscode(or else)
+
+To get the output of our project make sure you have google Chrome, Mozila or any other browser installed.
+
+## Install 
+
+> In order to install this project please go through the following steps:
+
+1. - [ ] Open the `Terminal`
+2. - [ ] Navigate to the directory where you want to add this repository
+3. - [ ] Run `git clone https://github.com/GedeonTS/Leaderboard.git`
+4. - [ ] Run `npm install` to install the necessary modules
+5. - [ ] Run `npm start`
+
+
+### Run the following commands to run linter tests
+
+WebHint
+```bash
+$ npx hint .
+```
+
+StyleLint
+```bash
+$ npx stylelint "**/*.{css,scss}"
+```
+
+ESLint
+```bash
+$ npx eslint .
+```
+
+### Usage
+
+> Open the index.html file with your code editor of your choice and/or a browser of your choice.
+```bash
+Open the project using a live saver extension that can be found into your code editor.
+```
+
+## Authors
+
+👤 **GedeonTS**
+
+- GitHub: [@GedeonTS](https://github.com/GedeonTS)
+- Twitter: [@Gedeon191](https://twitter.com/Gedeon191)
+- LinkedIn: [Ushindi Gedeon](https://linkedin.com/in/ushindi-gedeon-73032a228)
+
+
+👤 **Lembani Sakala**
+
+- GitHub: [@lembani](https://github.com/lembani)
+- Twitter: [@lembani_](https://twitter.com/lembani_)
+- LinkedIn: [lembani-sakala-b58615109](https://linkedin.com/in/lembani-sakala-b58615109)
+
+
+
+## Show your support
+
+Give a ⭐️ if you like this project!
+
+## Acknowledgments
+
+- Hat tip to anyone who helped us.
+
+## 📝 License
+
+This project is [MIT](./MIT.md) licensed.
+
+