readme.md in rubrowser-2.7.1 vs readme.md in rubrowser-2.8.0
- old
+ new
@@ -1,6 +1,6 @@
-# Rubrowser
+# Rubrowser (Ruby Browser)
[](https://badge.fury.io/rb/rubrowser)
[](https://travis-ci.org/emad-elsaid/rubrowser)
@@ -15,11 +15,11 @@
file, so you can generate it in your CI build and publish it as part of your
documentation
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.
@@ -49,15 +49,16 @@
## Usage
```
-Usage: /home/emad/code/rubrowser/bin/rubrowser [options] [file] ...
+Usage: rubrowser [options] [file] ...
-o, --output=FILE output file page, if not specified output will be written to stdout
-l, --layout=FILE layout file to apply on the resulting graph
-s, --server=SERVER:PORT rubrowser server for execution monitoring
-T, --no-toolbox Don't display toolbox on the page
+ -j, --json Do export data as JSON instead of HTML
-v, --version Print Rubrowser version
-h, --help Prints this help
```
if you run it without any options
@@ -116,9 +117,16 @@
rubrowser -l .rubrowser
```
So that in the future probably rubrowser can pick the file automatically, if you
follow that naming, your project will be ready in that case.
+
+## Export data for use in external tools
+
+```
+rubrowser -j|jq '.'
+```
+
## Features
* trace your execution in realtime on the graph
* interactive graph, you can pull any node to fix it to some position