diff --git a/README.md b/README.md index 79df5d1..089ee1f 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,50 @@ -## Quotes-Generator +# Quotes-Generator -This is a website for generating random quotes which can be tweeted. It uses basic HTML, CSS, and JS with a few helpful packages. +This is a website for generating random quotes which can then be tweeted. This is built with basic HTML, CSS, and JS with a few helpful packages. +`Generate` : picks text and an author out of a list of quotes. (from the quotes.js file) -`Generate` button: picks text and author out of a list of quotes from quote.js +`tweet this` : redirects you to a tweet text box url with the quote that was generated. -`tweet this`. redirect you to tweet text box url with the quote you generated +`copy` : copies the current quote to your clipboard. -`copy` button: qoute basically copies the current quote +`Download` : uses the package [npm-text-image](https://www.npmjs.com/package/text-image) to capture and format the quote to image/png and saves it to your local storage. -`Download` button: uses the package [npm-text-image](https://www.npmjs.com/package/text-image) to capture and format the quote to image/png and saves it to your local storage. - -Please give this project a star 🌟 and don't forget to follow me 😊. +**Please give this project a star 🌟 and don't forget to follow me 😊.** +## Interested in Contributions? If you are looking to make your first contribution, follow the steps below. -Check the CONTRIBUTING.md file if you are already familiar with the git workflow. -fork this repository +Check the *CONTRIBUTING.md* file if you are already familiar with the git workflow. -#### If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/). +*If you don't have git on your machine, [you can install it here](https://help.github.com/articles/set-up-git/).* + +fork this repository -## Fork this repository +## Step 1: Fork This Repository Fork this repository by clicking on the fork button on the top of this page. + This will create a copy of this repository in your account. -## Clone the repository -clone this repository +## Step 2: Clone The Repository -Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon. +Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the `copy to clipboard` icon. + +clone this repository Open a terminal and run the following git command: ``` -git clone "url you just copied" +git clone (place copied text here) ``` -where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. +Place the url to this repository (your fork of this project) in the `(place copied text here)` spot, don't keep the parenthesis. copy URL to clipboard -For example: +**For example:** ``` git clone https://github.com/this-is-you/Quotes-Generator.git @@ -49,9 +52,9 @@ git clone https://github.com/this-is-you/Quotes-Generator.git where `this-is-you` is your GitHub username. Here you're copying the contents of the Quotes-Generator repository on GitHub to your computer. -## Create a branch +## Step 3: Create a Branch -Change to the repository directory on your computer (if you are not already there): +If you're not already there, change to the repository's directory in your terminal: ``` cd Quotes-Generator @@ -63,17 +66,17 @@ Now create a branch using the `git checkout` command: git checkout -b your-new-branch-name ``` -For example: +**For example:** ``` git checkout -b add-whatever-you-want ``` -## Make necessary changes and commit those changes +## Step 4: Making and Committing Changes git status -If you go to the project directory and execute the command `git status`, you'll see there are changes. +If you go to the project directory and execute the command `git status`, you'll see that there are changes. Add those changes to the branch you just created using the `git add` command: @@ -87,7 +90,7 @@ Now commit those changes using the `git commit` command: git commit -m "Add <...>" ``` -## Push changes to GitHub +## Step 5: Push Changes to GitHub Push your changes using the command `git push`: @@ -97,9 +100,9 @@ git push origin -u replacing `` with the name of the branch you created earlier. -## Submit your changes for review +## Step 6: Submit Your Changes for Review -If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. +If you go to your repository on GitHub, you'll see a `compare & pull request` button. Click on that button. create a pull request