diff --git a/LICENSE b/LICENSE index cbba283..e09eeb4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE Version 2, December 2004 - Copyright (C) 2019 James Jarvis + Copyright (C) 2019 James Jarvis Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long diff --git a/README.md b/README.md index 4cdca99..6dfc853 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,21 @@ [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 @@ -18,6 +24,8 @@ 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) diff --git a/screenshot-gh.png b/screenshot-gh.png new file mode 100644 index 0000000..c88529c Binary files /dev/null and b/screenshot-gh.png differ diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..a0aaf94 Binary files /dev/null and b/screenshot.png differ