Open
Description
Thanks to @warengonzaga for the idea of putting example usages in the README.
There is now an 🚀 Example usage section in the README for profiles and repositories that have unique usages of Typing SVGs.
If you have a particularly cool way of using Typing SVGs on your profile, show it off by leaving a link to your profile in the README.
This issue is beginner friendly, if you have any questions, don't hesitate to ask.
Steps to open a PR
Using GitHub website
- Click the pencil above the README to fork the repo and start editing
- Add a line at the bottom of the list with your name and a link to your profile in the same format as the other examples
- Add a message and create a new branch describing your changes
- Click "Propose Changes"
- Replace the PR description with "Added example to README" and then click "Create pull request"
- You're done! Wait for your pull request to be reviewed.
Using GitHub CLI
- Fork the repo by clicking the button in the top-right or by running
gh repo fork DenverCoder1/readme-typing-svg
- Clone your fork to your computer (if you did not do so by running
gh repo fork
)
git clone https://github.com/<YOUR USERNAME>/readme-typing-svg.git
cd readme-typing-svg
- Create a new branch and switch to it
git checkout -b added-<YOUR USERNAME>-to-readme
- Open README.md in a code editor and add a line at the bottom of the list with your name and a link to your profile in the same format as the other examples
- Stage, commit, and push your changes
git add .
git commit -m "Added <YOUR USERNAME> to readme"
git push origin main
- View your fork on GitHub and you should see an option to compare and pull request.
- Compare your branch with
DenverCoder1:main
and start creating a Pull Request - Replace the PR description with "Added example to README" and then click "Create pull request"
- You're done! Wait for your pull request to be reviewed.