Skip to content

Commit f8401f2

Browse files
authored
Update documentation (#41)
1 parent 2f71301 commit f8401f2

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

.github/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ GitHub Activity Generator [![Gitter](https://badges.gitter.im/github-activity-ge
44
A script that helps you *instantly* generate a beautiful GitHub Contributions Graph
55
for the last year.
66

7+
## ⚠ Disclaimer
8+
This script doesn't encourage you to cheat. Cheating is bad. But if anybody judges your professional skills by
9+
the graph on your GitHub profile (which carries no value), they deserve to see a rich graph.
10+
11+
## What it looks like
12+
713
### Before :neutral_face: :no_mouth: :unamused:
814
![Before](before.png)
915
### After :muscle: :relieved: :heart: :sunglasses: :metal: :horse: :wink: :fire: :dancer: :santa: :fireworks: :cherries: :tada:
@@ -26,12 +32,9 @@ per day). Once the commits are generated it links the created repository with
2632
the remote repository and pushes the changes.
2733

2834
## Making contributions private
29-
Note: This script doesn't encourage you to cheat. Cheating is bad. But if anybody
30-
is judging your professional skills by the graph at your GitHub profile (which
31-
caries no value) they deserve to see a rich graph.
3235

33-
For that matter, you might want to make the generated repository private. It is free
34-
on GitHub. Now, you only need to set up your account
36+
You might want to make the generated repository private. It is free
37+
on GitHub. You only need to set up your account
3538
[to show private contributions](https://help.github.com/en/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).
3639
This way GitHub users will see that you contributed something, but they won't be
3740
able to see what exactly.

0 commit comments

Comments
 (0)