Added all important commandline options. Updated documentation.

[javainspect.git] / README.md

diff --git a/README.md b/README.md
index 8faca98..5ffec69 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
 
 Visualize java class relationships as Graphviz.
 
-Forked from the original work from Svjatoslav Agejenko. This repository
-only provides minor improvements.
+Forked from the original work from [Svjatoslav Agejenko](http://www.svjatoslav.eu/).
+This repository only provides minor improvements.
 
 Original [git repository](http://www2.svjatoslav.eu/repositories/javainspect.git)
 
@@ -15,3 +15,33 @@ Minor enhancements:
 - Produces single executable with dependencies.
 - Default to render SVG.
 - Default to output to `user.dir` (i.e. working directory).
+
+### Building
+
+1. Install [Maven](http://maven.apache.org/).
+2. Package JAR:
+
+    `mvn clean package`
+
+### Running
+
+1. You will need to add the classes would like to visualize to your classpath.
+2. Provide a package glob pattern to identify the classes you want to visualize.
+3. Name your output.
+
+```bash
+java \
+  -cp .:./example/target/myproject-0.0.jar:./target/javainspect-1.6-SNAPSHOT.jar \
+  eu.svjatoslav.inspector.java.methods.Main \
+  ./example/src/main/java/ com.myproject.* myproject
+```
+
+Here we want to visualize _com.myproject.*_ classes found in
+*./example/src/main/java/*. The resulting *dot* and *svg*
+file will be prefixed with *myproject*.
+
+### Output example
+
+![MyProject output](https://github.com/abargnesi/javainspect/raw/master/myproject.png)
+
+The [dot](https://github.com/abargnesi/javainspect/raw/master/myproject.dot) file is also saved.