Skip to content

Commit 4d0629f

Browse files
committed
general tidying and readme improvements
1 parent 23ec371 commit 4d0629f

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
22
Version 2, December 2004
33

4-
Copyright (C) 2019 James Jarvis <jjhaslanded@gmail.com>
4+
Copyright (C) 2019 James Jarvis <git@jamesjarvis.io>
55

66
Everyone is permitted to copy and distribute verbatim or modified
77
copies of this license document, and changing it is allowed as long

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,30 @@
22

33
[https://jamesjarvis.github.io/git-art/](https://jamesjarvis.github.io/git-art/)
44

5+
[![GitArt](screenshot.png)](https://jamesjarvis.github.io/git-art/)
6+
7+
[![You too could look this cool](screenshot-gh.png)](https://github.com/jamesjarvis)
8+
59
A project to allow anyone to customise their github activity/contributions graph with whatever they want.
610

7-
Feel like adding some text? Sure
11+
Feel like adding some text? *Sure*
812

9-
Feel like painting something onto it? Sure
13+
Feel like painting something onto it? **Go nuts**
1014

1115
Doesn't look fantastic at the moment, so feel free to submit a pull request where you just rm -rf. (That probably won't be approved, but a UI improvement would be much appreciated).
1216
The license is what is says on the tin, fork off and have fun with the code.
1317

18+
## Local development
19+
1420
To run it locally:
1521

1622
```bash
1723
yarn
1824
yarn start
1925
```
2026

27+
## Disclaimer
28+
2129
As always, be extra careful when downloading and running scripts from the internet. Even though all this does is make silly git repositories for you to ruin your git contribution board, and the source code is available here for you to scrutinise, you should **always** read through any script you download before you run it.
2230

2331
Other notable and very similar tools: [https://github.com/gelstudios/gitfiti](https://github.com/gelstudios/gitfiti)

screenshot-gh.png

77.1 KB
Loading

screenshot.png

638 KB
Loading

0 commit comments

Comments
 (0)