Skip to content

Commit

Permalink
Merge pull request #4 from agoragames/readme_update
Browse files Browse the repository at this point in the history
add note about user object respnding to uid
  • Loading branch information
cadwallion committed Jan 5, 2012
2 parents 8c2e7eb + eb35864 commit ac85916
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Expand Up @@ -20,8 +20,7 @@ Beta.config do |config|
end
```

Finally, Beta requires the existence of a `current_user` to use the
`whitelist` or `current_user_on_whitelist?` methods.
Finally, Beta requires the existence of a `current_user` which responds to the attribute specified in the `uid` configuration key used in both the `whitelist` and `current_user_on_whitelist?` methods.

# Usage

Expand All @@ -30,5 +29,5 @@ the following methods:

* `whitelist` - Used as a before\_filter to ensure the `current_user` has access
* `is_whitelisted?(user)` checks to see if the given user is on the list.
* `current_user_on_whitelist?` leverages `is_whitelisted?` to tell you if the current user is special. Requires the existence of a `current_user` method.
* `current_user_on_whitelist?` leverages `is_whitelisted?` to tell you if the current user is special.

0 comments on commit ac85916

Please sign in to comment.