README.rdoc in stffn-declarative_authorization-0.2.5 vs README.rdoc in stffn-declarative_authorization-0.3.0

- old
+ new

@@ -342,16 +342,20 @@ See Authorization::TestHelper for more information. = Installation of declarative_authorization -To install simply execute in your applications root directory - cd vendor/plugins && git clone git://github.com/stffn/declarative_authorization.git +One of three options to install the plugin: +* Install by Gem: Add to your environment.rb in the initializer block: + config.gem "stffn-declarative_authorization", :lib => "declarative_authorization" + And call from your application's root directory + rake gems:install +* Alternatively, to install from github, execute in your application's root directory + cd vendor/plugins && git clone git://github.com/stffn/declarative_authorization.git +* Or, download one of the released versions from Github at + http://github.com/stffn/declarative_authorization/downloads -Alternatively, download one of the released versions from Github at -http://github.com/stffn/declarative_authorization/downloads - Then, * provide the requirements as noted below, * create a basic config/authorization_rules.rb--you might want to take the provided example authorization_rules.dist.rb in the plugin root as a starting point, @@ -359,12 +363,12 @@ == Providing the Plugin's Requirements The requirements are * Rails >= 2.1 and Ruby >= 1.8.6, including 1.9 * An authentication mechanism -* A user object returned by controller.current_user -* An array of role symbols returned by user.role_symbols +* A user object returned by Controller#current_user +* An array of role symbols returned by User#role_symbols * (For model security) Setting Authorization.current_user to the request's user Of the various ways to provide these requirements, here is one way employing restful_authentication. @@ -414,11 +418,11 @@ * add roles to your User objects using e.g. user.roles.create(:title => "admin") Note: If you choose to generate an Account model for restful_authentication -instead of a User model as described below, you have to customize the +instead of a User model as described above, you have to customize the examples and create a ApplicationController#current_user method. == Debugging Authorization @@ -445,10 +449,10 @@ Then, point your browser to http://localhost/authorization_rules The browser needs Rails 2.3 (for Engine support). The graphical view requires Graphviz (which e.g. can be installed through the graphviz package under Debian -and Ubuntu) and is only tested under Linux. +and Ubuntu) and has only been tested under Linux. = Help and Contact We have an issue tracker[http://stffn.lighthouseapp.com/projects/20733-declarative_authorization]