readme.md in rubrowser-0.1.4 vs readme.md in rubrowser-0.1.5
- old
+ new
@@ -14,23 +14,31 @@
* if you reference a class that is not defined in your project it won't be in the graph, we only display the graph of classes/modules you defined
* the server analyze your code once upon the script starts if you changed your code you'll have to restart rubrowser
* it statically analyze the code so meta programming is out of question in here
* rails associations are meta programming so forget it :smile:
-## Usage
+## Installation
+
```
gem install rubrowser
-rubrowser /path/to/project/or/file
```
-or you can just visualize current directory
+## Usage
+
```
-rubrowser
+Usage: bin/rubrowser [options] [file] ...
+ -p, --port=PORT Specify port number for server, default = 9000
+ -v, --version Print Rubrowser version
+ -h, --help Prints this help
```
-it'll analyze the project and open port 9000, so you can access the graph from `localhost:9000`
+if you run it without any options
+```
+rubrowser
+```
+it'll analyze the current directory and open port 9000, so you can access the graph from `localhost:9000`
## Features
* interactive graph, you can pull any node to fix it to some position
* to release node double click on it