added readme for fork
authorAnthony Bargnesi <abargnesi@gmail.com>
Thu, 22 Sep 2016 17:12:36 +0000 (13:12 -0400)
committerAnthony Bargnesi <abargnesi@gmail.com>
Thu, 22 Sep 2016 17:12:36 +0000 (13:12 -0400)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..8faca98
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# JavaInspect
+
+Visualize java class relationships as Graphviz.
+
+Forked from the original work from Svjatoslav Agejenko. This repository
+only provides minor improvements.
+
+Original [git repository](http://www2.svjatoslav.eu/repositories/javainspect.git)
+
+Original [documentation](http://www2.svjatoslav.eu/gitbrowse/javainspect/doc/index.html)
+
+Minor enhancements:
+
+- Provides java main to run as CLI tool.
+- Produces single executable with dependencies.
+- Default to render SVG.
+- Default to output to `user.dir` (i.e. working directory).