README.md in society-1.6 vs README.md in society-1.7
- old
+ new
@@ -1,8 +1,8 @@
# Society
-Society analyzes and presents social graphs of relationships between classes in a Ruby or Rails project. It displays relationships that are either explicitly declared (e.g. in an ActiveRecord relation) or defined by calls between classes (e.g. in the source of ClassA there is a call to ClassB).
+Society analyzes and presents social graphs of relationships between classes in a Ruby or Rails project. It displays relationships that are either explicitly declared (e.g. in an ActiveRecord relation) or defined by calls between classes (e.g. in the source of ClassA there is a call to ClassB).
Please note that Society requires Ruby 2.1 or later.
## Sample output
@@ -16,11 +16,13 @@
## Installation
Add this line to your application's Gemfile:
- gem 'society'
+```ruby
+gem 'society'
+```
And then execute:
$ bundle
@@ -30,18 +32,18 @@
## Usage
From your terminal:
- society from path/to/models [more/paths/if/applicable]
+ $ society from path/to/models [more/paths/if/applicable]
-and then open `doc/society/index.htm` in your browser.
+and then open `doc/society/index.htm` or `doc/society/society.csv` in your browser.
For more complex applications, society also supports file globbing:
society from ../path/to/models/*user*
-The default format is HTML; you can skip the HTML interface and just get the
+The default format is HTML and CSV; you can skip the HTML interface and just get the
JSON by passing `--format json`
Note that all JSON data is timestamped (regardless of output format) to store
snapshots of your project over time.