description enhance

Author: zitros

README.md

@@ -1,2 +1,23 @@
 # CacheUMLExplorer
-An UML Class explorer for InterSystems Caché.
+An UML Class explorer for InterSystems Caché. It can build UML class diagram for any class in Caché.
+
+## Screenshots
+
+![2015-04-21_214058](https://cloud.githubusercontent.com/assets/4989256/7260103/6c1e2a20-e870-11e4-8bf0-9832885be9ab.png)
+
+## Installation
+
+###### Import classes to Caché
+To install Caché UML class explorer, download the [latest release](https://github.com/ZitRos/CacheUMLExplorer/releases) or build project by yourself. Then import XML file inside <code>Cache</code> directory of archive or directory.
+
+###### Set up WEB application
+When you have imported and compiled <b>UMLExplorer package</b> in Caché, make sure the namespace is the same you have imported classes to. Then go to <code>system management portal -> administering -> security -> applications -> web applications</code> and create there a new web application. Fill the <code>name</code> field of it with <code>/UMLExplorer</code> (slash is required) and set the value of <code>dispatch class</code> to <code>UMLExplorer.Router</code>. Click save. Now your WEB application is ready.
+
+###### Use it
+Visit <code>[server domain and port]/UMLExplorer/</code> (with slash at end) to enter application.
+
+## Build
+
+To build project, you need [NodeJS](https://nodejs.org) platform to be installed. Then, clone source code and run <code>npm install</code> from the root of the project. This will install all necessary modules from NPM. Also run <code>npm install -g gulp</code> if you have no gulp builder in your modules.
+
+After that and each next time just run <code>gulp</code> command from the project root. This will generate <code>build</code> directory, where you will found all what you need.