Warning

When using this template, remember to name your repo github-kudos

🙌 GitHub-Kudos Template

Template to use github-kudos. Use this repository as a template to write your kudos to other github users.

🚀 Getting Started

Repository Name

Important

GitHub-Kudos is looking for a repository called github-kudos.

So make sure that your repo is called like that.

Write Kudos

Important

To write kudos to someone, create a markdown file with their GitHub username.

So, for example, you want to give kudos to the user @manuelarte, you would need to create a file called manuelarte.md, and put your kudos message inside that file.

Get the image

Tip

You can view the image generated from your kudos at https://github-kudos.com/{{your-github-username}}/kudos/{{other-github-username}}.

Examples

Manuelarte and Octocat

So imagine that Manuelarte (username manuelarte) wants to give kudos to Octocat (username octocat). What Manuelarte needs to do is:

• Use this template to create a new repository called manuelarte/github-kudos.
• Create a file named octocat.md, and write a message.
• Now, her kudos image is available at https://github-kudos.com/manuelarte/kudos/octocat

See It In Action

• Example manuelarte/github-kudos
• Example on how GitHub-Kudos app can be used to display kudos in a GitHub profile