git commit -m "Adding a new commit"
-git commit
git commit -m "Commit on master"
+## Status & Usage
+
+Grawkit has basic support for common `git` commands such as `git branch`, `git tag` and `git merge`, allowing for fairly complex graphs. The integrated test-suite serves as an example, check the `tests` folder for more.
+
+In order to use this tool, either run the `grawkit` executable against a file containing supported
+`git` commands (any command not recognized will be silently ignored), or pass these in standard
+input. For instance, given the following file `test.txt`:
+
+```sh
+git commit -m "Commit on master"
git commit -m "More stuff"
git branch test-stuff
@@ -35,78 +34,20 @@ git commit -m 'Testing stuff'
git commit
git checkout master
-git commit
git branch test-merging
-
-git commit -m "Commit on master"
-git commit -m "Still on master"
-
-git checkout test-merging
-git commit -m 'A sample commit'
-
-git checkout master
-git commit -m "Another master commit"
-
-git merge test-merging
git commit -m "Commit on master"
-
-git branch test-first
-git branch test-second
-
-git commit -m "Still on master"
-git tag v.1.0.0
-
-git checkout test-first
git commit
+```
-git branch test-third
+You can execute either:
-git checkout test-second
-git commit
-git merge test-first
-git tag v.2.0.0-rc1
+```
+cat test.txt | grawkit
+# or
+grawkit test.txt
+```
-git checkout master
-git merge test-second
+Which will produce SVG markup to standard output, rendered as:
-git checkout test-third
-git commit
git branch develop
-git checkout develop
-git commit
-
-git branch feature/XYZ-12_fix-foo
-git checkout feature/XYZ-12_fix-foo
-git commit
-git commit
-
-git checkout develop
-git branch feature/ZZ-704_take-it-to-the-limit
-git checkout feature/ZZ-704_take-it-to-the-limit
-git commit
-
-git checkout develop
-git merge feature/XYZ-12_fix-foo
-
-git branch feature/ABC-66_make-bar
-git checkout feature/ABC-66_make-bar
-git commit
-git commit
-
-git checkout develop
-git merge feature/ZZ-704_take-it-to-the-limit
## License