Update README.md

README.md

@@ -1,25 +1,52 @@
-[![version](https://img.shields.io/badge/version-0.0.5-brightgreen.svg)](https://github.com/alexzaitsev/apk-dependency-graph/releases/tag/0.0.5) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-apk--dependency--graph-blue.svg?style=flat)](http://android-arsenal.com/details/1/4411)
+[![version](https://img.shields.io/badge/version-0.1.0-brightgreen.svg)](https://github.com/alexzaitsev/apk-dependency-graph/releases/tag/0.1.0) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-apk--dependency--graph-blue.svg?style=flat)](http://android-arsenal.com/details/1/4411)
 
-Android dependency visualizer. It's tool that helps to visualize current state of your project. It's really easy to see how tight your classes are coupled.
+Android dependency visualizer. It's a tool that helps to visualize current state of your project. It's really easy to see how tight your classes are coupled.
 
 ## Theory
+
 Class coupling is one of the significant code metrics which shows how easy is to change your code. Actually the architecture of microservices is based on the idea that the modules should be low-coupled so you are able to easily replace one module with another one with the same interface. This tool helps to view whole picture of your project. Check yourself!
 
-## Requirements
-You need at least **Java 7** to run `jar` files.
+## Project structure
+
+This project consists of the several parts:
+* lib (apktool)
+* src, build (apk-dependency-graph)
+* gui (d3)
+* run scripts  
+###### To get more information please check our wiki page.
+
+## Compile 
+
+To compile `build/jar/apk-dependency-graph.jar` you need:
+* **ant 1.9.9** or newer.
+* at least **Java 5**  
+From terminal just move to the parent folder of the project and run `ant` command. Classes will be generated to `build/classes` folder and jar file will appear onto `build/jar` folder.
+
+## Run
+
+You need at least **Java 7** to run `apktool` and `apk-dependency-graph` `jar` files.
 
 ## Usage
+
 ### Fast way
 I've prepared helpful scripts for you. All you need to do is to clone this repository (or download and unpack release archive) and type the next command in your command line:  
 *For Windows*:
 ```
-run.bat full\path\to\the\apk\app-release.apk com.example.test
+run.bat full\path\to\the\apk\app-release.apk com.example.test true
 ```
-where `run.bat` is a path to script in your local repository, `full\path\to\the\apk\app-release.apk` is a full path to the apk file you want to analize, `com.example.test` is a filter. **We recommend to use your package name as a filter so you will avoid unnecessary dependencies in your graph. If you don't want to filter just pass `nofilter`.**  
+or  
+```
+run.bat full\path\to\the\apk\app-release.apk nofilter false
+```
+where `run.bat` is a path to script in your local repository, `full\path\to\the\apk\app-release.apk` is a full path to the apk file you want to analize, `com.example.test` is a filter. **We recommend to use your package name as a filter so you will avoid unnecessary dependencies in your graph. If you don't want to filter just pass `nofilter`.** The last argument defines whether you want to skip inner classes on your graph (_true_ to skip, _false_ otherwise).  
 *For Unix*:
 ```
-./run.sh full/path/to/the/apk/app-release.apk com.example.test
+./run.sh full/path/to/the/apk/app-release.apk com.example.test true
 ```
+or  
+```
+./run.sh full/path/to/the/apk/app-release.apk nofilter false
+```  
 Wait until the command finishes:
 ```
 I: Using Apktool 2.2.0 on app-release.apk
@@ -35,23 +62,24 @@ I: Copying unknown files...
 I: Copying original files...
 Success! Now open index.html in your browser.
 ```
-It will decompile your apk and create apk-file-name folder in the same folder where the script is. After this it will analyze the smali code and generate `analyzed.js` file which contains all dependencies.   
-**Now open `index.html` in your browser and enjoy!**
+It will decompile your apk and create `apk-file-name` folder in the same folder where the script is. After this it will analyze the smali code and generate `gui/analyzed.js` file which contains all dependencies.   
+**Now open `gui/index.html` in your browser and enjoy!**
 ### Long way
 If you don't want to use `run` scripts you can do all the stuff from the command line by yourself.  
 Firsly, decompile your apk with the `apktool` jar:  
 ```
 java -jar apktool_2.2.0.jar d path-to-apk.apk -o path-to-folder-with-decompiled-files -f
 ```
-After this run `analyzer`:  
+After this run `apk-dependency-graph`:  
 ```
-java -jar apk_dependency_graph_0.0.5.jar -i path-to-folder-with-decompiled-files -o analyzed.js -f com.example.test
+java -jar build/jar/apk-dependency-graph.jar -i path-to-folder-with-decompiled-files -o analyzed.js -f com.example.test -d true
 ```
-I suggest to use your package name as filter. If you don't want to filter just pass `nofilter`.
+I suggest to use your package name as a filter. If you don't want to filter just pass `nofilter`.  
+**Now open `gui/index.html` in your browser and enjoy!**
 
 ## Examples
 
-Here the sample of good architecture with low class coupling:  
+Here is the sample of good architecture with low class coupling:  
 ![Good sample](image-good-example.jpg)
 
 And this one looks like a spaghetti:  
@@ -64,6 +92,7 @@ Does your project look like the first or the second picture? :)
 Watch [demo video](https://www.youtube.com/watch?v=rw501tvT4ko).
 
 ## Hashtag
+
 Share your awesome architecture using `#apkdependencyvizualizer` hashtag!
 
 ## Troubleshooting
@@ -74,4 +103,10 @@ If you have troubles look through [troubleshooting](https://github.com/alexzaits
 ## Credits
 
 There is the same tool for iOS: https://github.com/PaulTaykalo/objc-dependency-visualizer   
-I use `index.html` of that project. Thanks Paul for the great tool.
+I have used `gui/index.html` of that project. Thanks Paul for the great tool.
+
+## Contributors
+
+I want to say thank you to people who made even tiny pull request. This project is intended to improve current state of Android architecture all over the world so each detail is important. Below you can find a list of people who have found some time to improve this tool:
+
+* [WarrenFaith](https://github.com/WarrenFaith)