Quote - README, See wonderful quotes/fun-facts on your GitHub Profile README
Yep, you read it right ! There is a GitHub Action that lets you put an awe-inspiring fact or a famous quote on your GitHub Profile README, so that every morning, when you begin your work, you laugh, feel inspired and be determined.
The result before diving into steps:
Without dragging it further, keeping it short and simple, here are the steps:
1. Update your Profile README.md
file.
Add following in you Profile README.md
, wherever you want quotes/fun-facts to appear. Do not forget to commit the file ๐
<!--STARTS_HERE_QUOTE_README-->
<!--ENDS_HERE_QUOTE_README-->
It should look something like this:
Profile README.md
should be present in <username>/<username>
repository. Need to know more about profile repository/README, check out official docs.
2. Add workflow (yaml) file.
Now, click on Actions
tab on top of your profile repository <username>/<username>
.
Then, set up a workflow yourself.
Remove all the pre-entered contents of the yaml file and add the following:
name: Update Quote Readme
on:
workflow_dispatch:
schedule:
# Runs at 2 UTC everyday
- cron: "0 2 * * *"
jobs:
update-readme:
name: Update Quote README
runs-on: ubuntu-latest
steps:
- uses: siddharth2016/quote-readme@main
with:
COMMIT_MESSAGE: <your-commit-message> # default - Update with quote-readme
OPTION: both # default - both, can be one of (quote, funfact, both), if 'both' then will display either a quote or a fact
COMMIT_MESSAGE
and OPTION
variables are not needed, unless you want custom commit message and do not want to see either quotes or fun-facts on README.md
Name this yaml file as update-quote-readme.yml
or whatever suits you best and commit the workflow yaml file.
3. Test your action and see the Magic ๐งโโ๏ธ
Now, again go to Actions
tab.
Click Update Quote Readme
under workflows.
Then Run workflow
->Run workflow
, wait for it to complete.
And once the action is done then check your Profile README for a wonderful quote or a fun-fact !
Additionally you can link it back to the original repository to show your support for this action !
Change README.md
like this
<a href='https://github.com/marketplace/actions/quote-readme'>
<!--STARTS_HERE_QUOTE_README-->
<!--ENDS_HERE_QUOTE_README-->
</a>
Well, that was it, if you followed these steps you would be seeing an awe-inspiring quote or a fact on your Profile README.
Share your Profile README quotes/facts screenshot in the comments below ๐
If you faced any issues, please comment here or create an issue on this repository.
If you liked this not-so-useful action, then give it a star โญ
If you loved this not-so-useful action, then let's connect and contribute to making this a little bit useful!
Just starting your Open Source Journey ? Do not forget to check out Hello Open Source !
Need inspiration or a different perspective on the Python projects or just out there to explore? Check Awesome Python Repos
Want to make a simple and awesome game from scratch ? Check PongPong
Till next time !
Namaste ๐