Skip to content

Commit

Permalink
general tidying and readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesjarvis committed Jan 18, 2022
1 parent 23ec371 commit 4d0629f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2019 James Jarvis <[email protected]>
Copyright (C) 2019 James Jarvis <[email protected]>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,30 @@

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

[![GitArt](screenshot.png)](https://jamesjarvis.github.io/git-art/)

[![You too could look this cool](screenshot-gh.png)](https://github.com/jamesjarvis)

A project to allow anyone to customise their github activity/contributions graph with whatever they want.

Feel like adding some text? Sure
Feel like adding some text? *Sure*

Feel like painting something onto it? Sure
Feel like painting something onto it? **Go nuts**

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).
The license is what is says on the tin, fork off and have fun with the code.

## Local development

To run it locally:

```bash
yarn
yarn start
```

## Disclaimer

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.

Other notable and very similar tools: [https://github.com/gelstudios/gitfiti](https://github.com/gelstudios/gitfiti)
Binary file added screenshot-gh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4d0629f

Please sign in to comment.