README.md in society-0.13.2 vs README.md in society-1.0.0

- old
+ new

@@ -1,8 +1,9 @@ # Society -Society analyzes and presents a social graph of relationships between classes or methods. +Society analyzes and presents a social graph of relationships between classes or +methods. ## Installation Add this line to your application's Gemfile: @@ -16,34 +17,34 @@ $ gem install society ## Usage -Initialize a parser with source files: +From your terminal: - parser = Society::Parser.new("path/to/models") + society from path/to/models -Generate an object dependency graph: +and then open `doc/society/index.htm` in your browser. - graph = parser.class_graph +The default format is HTML; you can skip the HTML interface and just get the +JSON by passing `--format json` -Generate a method dependency graph: +Note that all JSON data is timestamped (regardless of output format) to store +snapshots of your project over time. - graph = parser.method_graph +## Updating assets -Generate JSON dependency matrix for export to d3: +All JavaScript and CSS dependencies are checked into the repo, so any given +commit should have everything it needs. However, if you're developing the gem +and need to pull in updates from the +[society-assets](https://github.com/CoralineAda/society-assets) package, you +can do so on the command line with `$ bower update`. - parser.matrix.to_jsno - -## TODO - -* Add fukuzatsu as a dependency - -* Wrap fukuzatsu parsing and remove duplicate classes - ## Contributing -Please note that this project is released with a [Contributor Code of Conduct](https://github.com/Bantik/society/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. +Please note that this project is released with a [Contributor Code of Conduct] +(http://contributor-covenant.org/version/1/0/0/). +By participating in this project you agree to abide by its terms. 1. Fork it ( https://github.com/[my-github-username]/society/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`)