README.md in active_explorer-0.0.8 vs README.md in active_explorer-0.0.9
- old
+ new
@@ -16,10 +16,12 @@
One picture is worth a thousand words:
+(GraphViz software needs to be installed on the system for this to work. See [Graphviz Installation](#graphvizinstallation).)
+
And the same objects in console output:
```ruby
Author(1592) {:first_name=>"Perer", :last_name=>"Brett"}
-> has Book(1642) {:author_id=>1592, :title=>"The Warded Man", :year=>2008}
@@ -45,10 +47,18 @@
```
$ gem install active_explorer
```
+### Graphviz Installation
+
+You need to have GraphViz software installed on your system.
+
+On Mac: `brew install graphviz`
+
+On other systems please take a look at official pages [http://www.graphviz.org/](http://www.graphviz.org/) or Google for it.
+
## Usage
In Rails, place this code into `application.rb`:
```ruby
@@ -206,14 +216,29 @@
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Appraisals
+
+To test support of many different versions I use [Appraisal gem](https://github.com/thoughtbot/appraisal) that allows me to define several different Gemfiles and test them all at once.
+
+See `Appraisals` file.
+
+Usage:
+
+1. Install gems by calling `appraisal install` (or `appraisal update` to update them)
+2. Run tests by calling `appraisal rspec` (or call specific version `appraisal activerecord-4-2 rspec`)
+
+Everything should be green ;)
+
## TODO
- Bug hunt.
-- Support all versions of Active Record >= 3.0.x
+- Colorize console output.
- Export to yuml.me graphing website.
+- Export to SVG.
+- Export to DOT language.
- Interactive graph.
- Rubymine plugin ;)
## Known Issues