README.md in petergate-1.6.8 vs README.md in petergate-1.6.9
- old
+ new
@@ -44,11 +44,11 @@
This will add a migration and insert petergate into your User model.
Usage
------
-#####User Model
+####User Model
Configure available roles by modifying this block at the top of your user.rb.
```ruby
############################################################################################
@@ -58,12 +58,23 @@
## The multiple option can be set to true if you need users to have multiple roles. ##
petergate(roles: [:admin, :editor], multiple: false) ##
############################################################################################
```
-Instance methods added to your User model include: `role, roles, roles=, available_roles`
+##### Instance Methods
-#####Controllers
+```ruby
+user.role => :editor
+user.roles => [:editor, :user]
+user.roles=(v) #sets roles
+user.available_roles => [:admin, :editor]
+user.has_roles?(:admin, :editors) # returns true if user is any of roles passed in as params.
+```
+##### Class Methods
+
+`User.role_editors => #list of editors. Method is created for all roles. role_admins, role_teachers, etc.`
+
+####Controllers
Setup permissions in your controllers the same as you would for a before filter like so:
```ruby
access all: [:show, :index], user: {except: [:destroy]}, company_admin: :all