readme.md in rubrowser-0.1.5 vs readme.md in rubrowser-0.1.6
- old
+ new
@@ -8,9 +8,17 @@
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:
+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
* 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: