diff --git a/README.md b/README.md index fa4a02d..7198479 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,3 @@ - - - - -
- - logo -
- -

Microverse README Template

- -
- # 📗 Table of Contents @@ -65,20 +26,26 @@ For more information on the importance of a professional README for your reposit # 📖 [your_project_name] -> Describe your project in 1 or 2 sentences. - **[your_project__name]** is a... ## 🛠 Built With ### Tech Stack -> Describe the tech stack and include only the relevant sections that apply to your project.
Client + +
+ +
+Technologies
@@ -100,35 +67,32 @@ For more information on the importance of a professional README for your reposit ### Key Features -> Describe between 1-3 key features of the application. - - **[key_feature_1]** - **[key_feature_2]** - **[key_feature_3]** -

(back to top)

- ## 🚀 Live Demo -> Add a link to your deployed project. +- [Live Demo Link](https://yourdeployedapplicationlink.com) -- [Live Demo Link](https://google.com) -

(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: +- A code editor (preferably VSCode) +- A browser +- Node.js (version 12 or higher to run javascript files locally) +- LiveServer (to load javascript modules) +- npm (version 6 or higher) or Yarn (version 1.22 or higher) ### Setup - Clone this repository to your desired folder: +- Open git bash on local computer +- clone the repo with: + +git clone from ```https://``` + -

(back to top)

- ## 👥 Authors -> Mention all of the collaborators of this project. - -👤 **Author1** +👤 **JOSECK OSUGO** -- GitHub: [@githubhandle](https://github.com/githubhandle) -- Twitter: [@twitterhandle](https://twitter.com/twitterhandle) -- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle) +- GitHub: [0sugo](https://github.com/0sugo) +- Twitter: [@0sugo5](https://twitter.com/osugo5) +- LinkedIn: [Joseck Osugo](https://www.linkedin.com/in/joseck-osugo/) -👤 **Author2** -- GitHub: [@githubhandle](https://github.com/githubhandle) -- Twitter: [@twitterhandle](https://twitter.com/twitterhandle) -- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle) - -

(back to top)

## 🔭 Future Features -> Describe 1 - 3 features you will add to the project. - - [ ] **[new_feature_1]** - [ ] **[new_feature_2]** - [ ] **[new_feature_3]** -

(back to top)

## 🤝 Contributing -Contributions, issues, and feature requests are welcome! +> Contributions, issues, and feature requests are welcome! -Feel free to check the [issues page](../../issues/). +> 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, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner at first attempt. Keep going! -If you like this project... - -

(back to top)

## 🙏 Acknowledgments -> Give credit to everyone who inspired your codebase. - -I would like to thank... - -

(back to top)

+> I'm thankful to Microverse for providing a study platform which guided me through this project and to my coding partners at Microverse for the collaborative effort. ## ❓ FAQ (OPTIONAL) -> Add at least 2 questions new developers would ask when they decide to use your project. +>The following are the most frequently asked questions about this project together with their answers. - **[Question_1]** @@ -278,14 +235,10 @@ I would like to thank... - [Answer_2] -

(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._ +> This project is [MIT](./LICENSE) licensed.

(back to top)