csimonis/gitfiti
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Update README.md

Browse Source
This commit is contained in:
Eric
2013-04-30 01:06:52 -03:00
parent 9cf0722fc7
commit 63cdc1110c
1 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,8 +1,24 @@
gitfiti ##gitfiti
======= gitfiti is a tool I wrote to (blatantly) abuse your github account's commit history calendar.
gitfiti is a tool I wrote to blatantly abuse your github account's commit history calendar.
I _highly_ recommend that you create a _new_ github repo when using gitfiti. I highly recommend that you create a _new_ github repo when using gitfiti.
Todo: ###Usage:
Finish web interface 1. create a new github repo to store your handiwork.
2. Run `gitfiti.py` and follow the prompts for username, art selection, offset, and repo name.
3. Run the generated `gitfiti.sh` from your home directory (or any non-git tracked dir) and watch it go to work.
4. Wait... Seriously, you'll probably need to wait a day or two for the gitfiti to show in your commit graph.
###Removal:
Fortunately if you regret your gitfiti in the morning, removing it is fairly easy: delete the repo you created for your gitfiti.
---
####Todo:
- Remove 'requests' dependency
- Web interface
- Load "art" from a file
- Load commit content from a file
- ...
- Profit?