README.md in rails-erd-1.1.0 vs README.md in rails-erd-1.2.0
- old
+ new
@@ -1,58 +1,74 @@
Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
========================================================================
-[Rails ERD](http://rails-erd.rubyforge.org/) is a Rails plugin that allows
-you to easily generate a diagram based on your Active Record models. The
-diagram gives an overview of how your models are related. Having a diagram
-that describes your models is perfect documentation for your application.
+[Rails ERD](http://voormedia.github.io/rails-erd/) is a Rails plugin that allows you to easily generate a diagram based on your Active Record models. The diagram gives an overview of how your models are related. Having a diagram that describes your models is perfect documentation for your application.
-The second goal of Rails ERD is to provide you with a tool to inspect your
-application's domain model. If you don't like the default output, it is very
-easy to use the API to build your own diagrams.
+The second goal of Rails ERD is to provide you with a tool to inspect your application's domain model. If you don't like the default output, it is very easy to use the API to build your own diagrams.
-Rails ERD was created specifically for Rails 3. It uses Active Record's
-built-in reflection capabilities to figure out how your models are associated.
+Rails ERD was created specifically for Rails 3. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.
Preview
-------
Here's an example entity-relationship diagram that was generated by Rails ERD:
-
+
-Browse the [gallery](http://rails-erd.rubyforge.org/gallery.html) for more
-example diagrams.
+Browse the [gallery](http://voormedia.github.io/rails-erd/gallery.html) for more example diagrams.
Getting started
---------------
-See the [installation instructions](http://rails-erd.rubyforge.org/install.html)
-for a complete description of how to install Rails ERD. Here's a summary:
+See the [installation instructions](http://voormedia.github.io/rails-erd/install.html) for a complete description of how to install Rails ERD. Here's a summary:
-* Install Graphviz 2.22+ ([how?](http://rails-erd.rubyforge.org/install.html))
+* Install Graphviz 2.22+ ([how?](http://voormedia.github.io/rails-erd/install.html))
* Add <tt>gem "rails-erd"</tt> to your application's Gemfile
* Run <tt>bundle exec erd</tt>
+### Configuration
+Rails ERD has the ability to be configured via the command line or through the use of a YAML file with configuration options set. It will look for this file first at `~/.erdconfig` and then `./.erdconfig` (which will override any settings in `~/.erdconfig`). The format of the file is as follows (shown here with the default settings used if no `.erdconfig` is found):
+
+```
+attributes:
+ - content
+ - foreign_key
+ - inheritance
+disconnected: true
+filename: erd
+filetype: pdf
+indirect: true
+inheritance: false
+markup: true
+notation: simple
+orientation: horizontal
+polymorphism: false
+warn: true
+title: sample title
+exclude: null
+only:
+```
+
+
Learn more
----------
-More information can be found on [Rails ERD's project homepage](http://rails-erd.rubyforge.org/).
+More information can be found on [Rails ERD's project homepage](http://voormedia.github.io/rails-erd/).
-If you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rails-erd.rubyforge.org/doc/).
+If you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rubydoc.info/github/voormedia/rails-erd/frames).
About Rails ERD
---------------
Rails ERD was created by Rolf Timmermans (r.timmermans *at* voormedia.com)
-Copyright 2010-2013 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
+Copyright 2010-2014 Voormedia - [www.voormedia.com](http://www.voormedia.com/)
License
-------