diff --git a/README.md b/README.md index 000a1f5..4fbe080 100644 --- a/README.md +++ b/README.md @@ -1 +1,246 @@ -# To-do-list \ No newline at end of file +# To-do-list + + + + +# 📗 Table of Contents + +- [📖 About the Project](#about-project) + - [🛠 Built With](#built-with) + + - [Key Features](#key-features) + - [🚀 Live Demo](#live-demo) +- [💻 Getting Started](#getting-started) + - [Setup](#setup) + - [Prerequisites](#prerequisites) + - [Install](#install) + +- [👥 Authors](#authors) + +- [🤝 Contributing](#contributing) +- [⭐️ Show your support](#support) + + +- [📝 License](#license) + + + +# 📖 [Awesome-Books] + +> Describe your project in 1 or 2 sentences. + +**[Awesome-Books]** Is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. You will build a simple website that allows for doing that, and you will do it using ES6 and Webpack!. + +## 🛠 Built With + +- HTML +- CSS +- JavaScript +- Webpacks + + + + + + + + + ### Key Features + +> Describe between 1-3 key features of the application. + +- **[Responsive]** +- **[Dynamic-Pages]** +- **[Add and Remove to do list]** + + +

(back to top)

+ + + +## 🚀 Live Demo + +> Add a link to your deployed project. + +- [Live Demo Link](Coming soon) + +

(back to top)

+ + + +## 💻 Getting Started + +> Describe how a new developer could make use of your project. + +To get a local copy up and running, follow these steps. + +### Prerequisites + +In order to run this project you need: + +- Web Browser +- Code Editor: [visual Studio code](https://code.visualstudio.com/) + +### Setup + +Clone this repository to your desired folder: + +1. Go to the [repository page](https://github.com/RaphDasilva/Awesome-books). +2. Press the "Code" button and copy the link. +3. Clone it using git command `git clone `. + +### Install + +Install this project with: + +``` +npm install +``` + +

(back to top)

+ + + + + + + + + + + + + + + +## 👥 Authors + +> Mention all of the collaborators of this project. + +👤 **Raphael Okolo** + +- GitHub: [@githubhandle](https://github.com/RaphDasilva) +- LinkedIn: [@LinkedIn](https://www.linkedin.com/in/raphael-okolo-480012227/) + + +

(back to top)

+ + + + + + + +## 🤝 Contributing + +Contributions, issues, and feature requests are welcome! + +Feel free to check the [issues page](../../issues/). + +

(back to top)

+ + + +## ⭐️ Show your support + +> Write a message to encourage readers to support your project + +If you like this project... + +

(back to top)

+ + + + + + + + + + + + +## 📝 License + +This project is [MIT](./LICENSE) licensed. + +_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._ + +

(back to top)