Update README.md

adililhan · Sep 6, 2013 · 9025b99 · 9025b99
1 parent 06ec056
commit 9025b99
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,36 @@ Defterdar
 =========
 
 PHP and Git with changelog generator
+
+#### How to works?
+
+Defterdar works with __"git tags"__.
+
+For example:
+
+```
+git clone https://github.com/USERNAME/YOUR_REPO.git
+
+echo 'Test' > README.md
+
+git commit -a -m "test commit"
+
+git tag v1
+
+git push origin v1
+
+```
+
+Calling now defterdar.php.
+
+e.g.: __`php defterdar.php`__
+
+Look at your CHANGELOG.md file.
+
+
+
+#### You are RoR (Ruby on Rails) Developer?
+
+No problem.
+
+Look at __[Katip Project](https://github.com/kebab-project/katip/)__.