Update README.md
updated todo, new screenshot, etc.
This commit is contained in:
22
README.md
22
README.md
@ -1,9 +1,18 @@
|
||||
gitfiti _noun_ : carefully crafted graffiti in a github commit history calendar.
|
||||
<img src='https://raw.github.com/gelstudios/gitfiti/master/pixels-large.png' alt='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:
|
||||

|
||||
|
||||
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:
|
||||

|
||||
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?
|
||||
|
||||
|
||||
|
||||

|
||||
|
Reference in New Issue
Block a user