readme.md in rubrowser-0.1.6 vs readme.md in rubrowser-0.2.0
- old
+ new
@@ -4,25 +4,26 @@
a visualizer for ruby code (rails or otherwise), it analyze your code and extract the modules definitions and used classes/modules and render all these information as a directed force graph using D3.
this project is so small that the visualization looks like so
-
+
-the idea is that the project opens every `.rb` file and parse it with `parser` gem then list all modules and classes definitions, and all constants that are listed inside this module/class and link them together, there are couple things you need to keep in mind:
+the idea is that the project opens every `.rb` file and parse it with `parser` gem then list all modules and classes definitions, and all constants that are listed inside this module/class and link them together.
Here are some output examples
| Gem | Visualization |
| ------------- |:-------------:|
| rack-1.6.4/lib |  |
| actioncable-5.0.0/lib |  |
| railties-5.0.0/lib |  |
-* if your file doesn't have a valid ruby syntax it won't be parsed and will cause the gem to stop
+there are couple things you need to keep in mind:
+
+* if your file doesn't have a valid ruby syntax it won't be parsed and will print warning.
* 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:
## Installation
@@ -33,11 +34,11 @@
## Usage
```
-Usage: bin/rubrowser [options] [file] ...
+Usage: rubrowser [options] [file] ...
-p, --port=PORT Specify port number for server, default = 9000
-v, --version Print Rubrowser version
-h, --help Prints this help
```
@@ -55,10 +56,10 @@
* highlight node and all related nodes, it'll make it easier for you to see what depends and dependencies of certain class
## Tests?
-what test? :D
+What tests? :smile:
## Why?
Because i didn't find a good visualization tool to make me understand ruby projects when I join a new one.