update readme.md

README.md

@@ -1,55 +1,58 @@
-# Fake commit history
+# Fake GitHub Commits
 
-A command-line tool to generate your git activity ¯\\_(ツ)_/¯.
+A command-line tool to fake your GitHub activity ¯\\_(ツ)_/¯.
 
 Does your profile look like you have stopped coding at all? 
 No worries, this script will help you!
 
 <img src="https://dl.dropboxusercontent.com/s/q2iinti6v0zbhzs/contributions.gif?dl=0" alt="How it works" />
 
-## Installation
+## How To Use
+
+1. Make sure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Node.js](https://nodejs.org/en/download/) installed on your machine. 
+2. Create the folder and initialize it:
+    ```shell script
+    mkdir my-history && cd my-history && git init
+    ```
+3. Generate your commits: 
+    ```shell script
+    npx fake-git-history
+   ```
+   It will generate changes to the file for every day within the last year (0-3 commits per day).
+4. Create [a private repository](https://github.com/new) called `my-history`,
+and push your fake history to the remote repository:
+    ```shell script
+    git remote add origin git@github.com:<USERNAME>/my-history.git
+    git push -u origin master
+    ```
+
+Done! Go take a look at your GitHub profile.
 
-Make sure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Node.js](https://nodejs.org/en/download/) installed on your machine. 
-Then install this tool:
-
-```shell script
-npm i -g fake-git-history
-```
-
-## Usage
-
-```shell script
-mkdir my-fake-history
-cd my-fake-history
-git init
-
-# Generate your commit history.
-fake-git-history
-```
+## Customizations
 
-Then create [a private repository](https://github.com/new) on GitHub,
-and follow the instructions to push the history to the remote repository.
+### `--commitsPerDay`
 
+Specify how many commits should be created for every single day. 
+Default is `0,3` which means it will randomly make from 0 to 3 commits a day. Example:
 ```shell script
-git remote add origin git@github.com:<USERNAME>/my-fake-history.git
-git push -u origin master
+npx fake-git-history --commitsPerDay "0,5"
 ```
 
-Done! Go take a look at your contributions graph.
+### `--workdaysOnly`
 
-## Customizations
-
-Specify how many commits should be created for every single day. 
-Default is `0,3` which means it will randomly make from 0 to 3 commits a day.
+Use it if you don't want to commit on weekends. Example:
 
 ```shell script
-fake-git-history --commitsPerDay "1,5"
+npx fake-git-history --workdaysOnly
 ```
 
-Use `--workdaysOnly` if you don't want to commit on weekends.
+### `--startDate` and `--endDate`
+
+By default, the script generates GitHub commits for every day within the last year. 
+If you want to generate activity for a specific dates, then use these options:
 
 ```shell script
-fake-git-history --workdaysOnly
+npx fake-git-history --startDate "2020/09/30"
 ```
 
 ## CLI