diff --git a/README.md b/README.md index 2a653bd..6134354 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Quote-Generator -> This is a fun project being a part of my [Javascript Web Projects: 20 Projects to build my Portfolio](https://www.udemy.com/course/javascript-web-projects-to-build-your-portfolio-resume/) by [Zero-To-Mastery Academy](https://zerotomastery.io/). +This is a simple web app based on HTML, CSS and Javascript. + +- Fething the data in JSON format from the API https://type.fit/api/quotes and saving it in a variable. +- Dynamically inserting a random quote into the DOM on initial loading. +- User is able to load a new quote on a button 'New Quote" click. +- User is able to tweet the quote if he liked it on a 'Twitter' button click. ## About: @@ -8,6 +13,28 @@ The webpage generates random quotes by famous personalities which can be obvious I had a lot of fun building this project and as usual I learned a lot from building this. Added some customisation to this project so....... +## Installation + +1. Open your terminal and change the current working directory to the location where you want the cloned directory to be made. + +```bash +$ cd path/to/your/folder/quote-generator/ +``` + +2. Clone repository by typing the following in your terminal: + +```bash +$ git clone git@github.com:WPBC/quote-generator.git +``` + +3. Open the index file to view the quote generator. All done. + +### License + +This package is released under the MIT license. + + + #### Feel free to fork and give a star for this project. ## Live Project