From f360f23c3b57b2b5ffb39c389befcd1e136ec0af Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= <bizauionica@yahoo.com>
Date: Mon, 26 Jan 2015 10:08:11 +0200
Subject: [PATCH] Added the README file.

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67b4892
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# git-stats
+A GitHub-like contributions calendar, but locally, with all your git commits.
+
+## Installation
+Run the following commands to download and install the application:
+
+```sh
+$ git clone https://github.com/IonicaBizau/git-stats.git git-stats
+$ cd git-stats
+$ npm install
+```
+
+## Documentation
+## `record(data, callback)`
+Records a new commit.
+
+### Params 
+- **Object** `data`: The commit data containing: 
+ - `date` (String|Date): The date object or a string in this format: `DDD MMM dd HH:mm:ss YYYY`
+ - `url` (String): The repository remote url.
+ - `hash` (String): The commit hash.
+
+- **Function** `callback`: The callback function.
+
+### Return
+- **** 
+
+## `get(data, callback)`
+Gets the git stats.
+
+### Params 
+- **Object** `data`: The stats filter. **Not yet implemented**.
+- **Function** `callback`: The callback function.
+
+### Return
+- **** 
+
+
+
+## How to contribute
+
+1. File an issue in the repository, using the bug tracker, describing the
+   contribution you'd like to make. This will help us to get you started on the
+   right foot.
+2. Fork the project in your account and create a new branch:
+   `your-great-feature`.
+3. Commit your changes in that branch.
+4. Open a pull request, and reference the initial issue in the pull request
+   message.
+
+## License
+See the [LICENSE](./LICENSE) file.