diff --git a/README.md b/README.md index 6978378ae6..9b7f41c9bc 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,42 @@ Run `Rockstar`, be a Rockstar, show off your Github profile to everyone and bag Time is very important. Do not waste time reading large manuals or [listen to people who tell you how to learn C++](http://norvig.com/21-days.html), run these couple of lines instead: +#### Install requirements +```bash +$ pip install -r requirements.txt +``` + +#### Set User +```bash +$ git config --global user.name "" +$ git config --global user.email "" +``` + +#### Create a commit.py ```py from rockstar import RockStar rock_it_bro = RockStar(days=300) rock_it_bro.make_me_a_rockstar() ``` +`days` specify number of boxes you want to fill with green. Default value is `400`. Remember, more commits, more green, more Rockstar you are! + +#### Run Commit.py +```bash +$ python commit.py +``` + +#### Remote a Git repo +```bash +$ git remote add origin git@github.com:User/Repo.git +``` + +#### Push it +```bash +$ git push origin master +``` -Above script will create a git repository in the current directory. After that, create a repo on Github and push the local repo. That's all! -`days` specify number of boxes you want to fill with green. Default value is `400`. Remember, more commits, more green, more Rockstar you are! #### Become a Rockstar Swift Programmer with 5 years of experience: