❝“I didn’t work hard to make Ruby perfect for everyone, because you feel differently from me. No language can be perfect for everyone. I tried to make Ruby perfect for me, but maybe it’s not perfect for you. The perfect language for Guido van Rossum is probably Python.”— Yukihiro Matsumoto, aka “Matz”, creator of Ruby ❞
5. Go to Workflows menu (mentioned in step 1), click `Update Quote Readme`, click `Run workflow`.
6. Go to your profile page, you will be able to see a random quote/fact wherever you placed [this](#update-your-readme) comment on README.
---
### Examples
1. If you want to use this action for a README that is not present in current workflow repository.
```yml
- uses: siddharth2016/update-readme-image@main
with:
GH_TOKEN: ${{ secrets.GH_TOKEN }} # Needed if README repository is not profile repo
REPOSITORY: <username>/<differentrepo>
Using REPOSITORY
will change README present in that repository head.
For example, if your workflow is present in <username>/repo1
and you want to update README present in <username>/repo2
, then assign REPOSITORY
to <username>/repo2
in workflow at <username>/repo1
.
- You can specify a commit message to override the default "Update with quote-readme".
- uses: siddharth2016/update-readme-image@main
with:
GH_TOKEN: ${{ secrets.GH_TOKEN }} # Needed if README repository is not profile repo
REPOSITORY: <username>/<differentrepo> # Needed if README repository is not current repo
COMMIT_MESSAGE: <your-commit-message> # default - Update with quote-readme
- You can also choose if you only want either a random
quote
or a randomfunfact
to appear on your readme, by default it isboth
.
- uses: siddharth2016/update-readme-image@main
with:
GH_TOKEN: ${{ secrets.GH_TOKEN }} # Needed if README repository is not profile repo
REPOSITORY: <username>/<differentrepo> # Needed if README repository is not current repo
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
To run tests simply execute the following in the directory containing main.py
:
python -m unittest discover