MINOR: Add readme

silverstripe-archive · Apr 17, 2012 · 32ab330 · 32ab330
1 parent f2b5915
commit 32ab330
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+## Overview
+
+Codeviz module provides some code insight based on file parsing and model inspection.
+
+It has been pulled out of the core in SilverStripe 3.0 and is provided as is.
+
+## Installation
+
+Drop the module to codeviz.
+For model graphs [Graphviz](http://graphviz.org/) is required.
+
+## Usage
+
+Just visit one of the following:
+
+	<webroot>/ModelViewer
+	<webroot>/CodeViewer
+	<webroot>/TestViewer