readme

orloffm · Nov 18, 2018 · 9dbe0ea · 9dbe0ea
1 parent 6205d99
commit 9dbe0ea
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 187 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,22 @@
-# prigitsk
+# Prigitsk
+
 [![Build status](https://ci.appveyor.com/api/projects/status/52iqd3aqo3axtni3?svg=true)](https://ci.appveyor.com/project/orloffm/prigitsk) [![Coverage Status](https://coveralls.io/repos/github/orloffm/prigitsk/badge.svg?branch=master)](https://coveralls.io/github/orloffm/prigitsk?branch=master)
 
-The console and web apps to draw Git Repository.
+This is a tool that draws graphs of Git repositories. It uses dot.exe from GraphViz for rendering and loosely follows Flow branching strategy.
+Currently available as a Windows console application,
+with plans to create a web-based version.
+
+## Usage
+
+1. Download GraphViz. Either add its `bin` folder to PATH or run `prigitsk configure` to specify path to it.
+2. Run from the directory of your Git repository:
+
+   prigitsk draw
+
+For options:
+
+    prigitsk draw --help
+
+## Example output
+
+![](doc/examples/common_example.png)
diff --git a/data/example.dot b/data/example.dot
diff --git a/doc/examples/common_example.png b/doc/examples/common_example.png