From 3ad59a2a19ef2af2619a21aadd5e55da66c4770e Mon Sep 17 00:00:00 2001 From: Eric Date: Tue, 21 May 2013 14:24:46 -0300 Subject: [PATCH] Update README.md updated todo, new screenshot, etc. --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 17411b9fe..5bfc49411 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ -gitfiti _noun_ : carefully crafted graffiti in a github commit history calendar. -gitfiti art +gitfiti _noun_ : Carefully crafted graffiti in a github commit history calendar. -`gitfiti.py` is a tool I wrote to decorate your github account's commit history calendar by (blatantly) abusing git. +An example of gitfiti in the wild: +![alt text](https://raw.github.com/gelstudios/gitfiti/master/gitfiti-screenshot.png "screenshot") -I highly recommend that you create a _new_ github repo when using gitfiti. +`gitfiti.py` is a tool I wrote to decorate your github account's commit history calendar by (blatantly) abusing git's ability to accept commits _in the past_. + +How? `gitfiti.py` generates a bash script: `gitfiti.sh` that makes commits with the GIT_AUTHOR_DATE and GIT_COMMITTER_DATE environment variables set for each targeted pixel. + +Since this is likely to clobber repo's history, I highly recommend that you create a _new_ github repo when using gitfiti. Also, the generated bash script assumes you are using public-key authentication with git. + + +###Pixel Art: +![alt text](https://raw.github.com/gelstudios/gitfiti/master/pixels-large.png "pixel art") +Included "art" from left to right: kitty, oneup, oneup2, hackerschool, octocat, octocat2 ###Usage: 1. Create a new github repo to store your handiwork. @@ -16,11 +25,12 @@ Fortunately if you regret your gitfiti in the morning, removing it is fairly eas --- ####Todo: -- Remove 'requests' dependency +- ~~Remove 'requests' dependency~~ - Web interface - Load "art" from a file - Load commit content from a file - ... - Profit? - + + ![alt text](http://f.cl.ly/items/0J463J0K1N020S1Q3E3l/er-small.png "tiny logo")