Update README. Reorganize installation steps #425
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sankalpk
commented
Nov 8, 2016
| @@ -5,11 +5,11 @@ Very simple Roles library without any authorization enforcement supporting scope | |||
| Let's see an example: | |||
|
|
|||
| ```ruby | |||
| user.has_role?(:moderator, Forum.first) | |||
| user.has_role?(:moderator, @forum) | |||
There was a problem hiding this comment.
A forum instance gives you one less concept to think about when trying to understand the example.
sankalpk
commented
Nov 8, 2016
| => false # if user is moderator of another Forum | ||
| ``` | ||
|
|
||
| This library can be easily integrated with any authentication gem ([devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), [Clearance](https://github.com/thoughtbot/clearance)) and authorization gem<span style="color: red"><strong>*</strong></span> ([CanCanCan](https://github.com/CanCanCommunity/cancancan), [authority](https://github.com/nathanl/authority)) | ||
| This library can be easily integrated with any authentication gem ([devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), [Clearance](https://github.com/thoughtbot/clearance)) and authorization gem<span style="color: red"><strong>*</strong></span> ([CanCanCan](https://github.com/CanCanCommunity/cancancan), [authority](https://github.com/nathanl/authority), [Pundit](https://github.com/elabs/pundit)) |
There was a problem hiding this comment.
I use it with Pundit, so thought it'd be nice to include it in the list
sankalpk
commented
Nov 8, 2016
| First, create your Role model and migration file using this generator: | ||
| First, use the generator to setup Rolify. Role and User class are the default names. However, you can specify any class name you want. For the User class name, you would probably use the one provided by your authentication solution. | ||
|
|
||
| If you want to use Mongoid instead of ActiveRecord, just add `--orm=mongoid` argument, and skip to step #3. |
There was a problem hiding this comment.
I think it makes sense to talk a bit about the options and names for the command prior to showing the command. For e.g. I'm used to copy and pasting commands as I read. In this case, if I have a different User class name or wanted to name Role something differently, I would've already pasted the command into the terminal and it might be a bit of a pain to undo.
sankalpk
commented
Nov 8, 2016
| For the User class name, you would probably use the one provided by your authentication solution. rolify just adds some class methods in an existing User class. | ||
|
|
||
| If you want to use Mongoid instead of ActiveRecord, just add `--orm=mongoid` argument, and skip to step #3 | ||
| The generator will create your Role model, add a migration file, and update your User class with new class methods. |
There was a problem hiding this comment.
The summary of what the generator does helps the user understand more of what is going on.
EppO
approved these changes
Nov 18, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Your README is pretty thorough and well thought out. Some minor changes to make it a little easier to understand. Explained in comments below.