docs/quick_start.md in action_policy-0.2.4 vs docs/quick_start.md in action_policy-0.3.0.beta1
- old
+ new
@@ -1,16 +1,16 @@
# Quick Start
## Installation
-To install Action Policy with RubyGems:
+Install Action Policy with RubyGems:
```ruby
gem install action_policy
```
-Or add this line to your application's `Gemfile`:
+Or add `action_policy` to your application's `Gemfile`:
```ruby
gem "action_policy"
```
@@ -20,13 +20,13 @@
## Basic usage
The core component of Action Policy is a _policy class_. Policy class describes how you control access to resources.
-We suggest that you have a separate policy class for each resource and encourage you to follow the conventions:
+We suggest having a separate policy class for each resource and encourage you to follow these conventions:
- put policies into the `app/policies` folder (when using with Rails);
-- name policies using the corresponding resource name (model name) with a `Policy` suffix, e.g. `Post -> PostPolicy`;
-- name rules using a predicate form of the corresponding activity (typically, a controller's action), e.g. `PostsController#update -> PostsPolicy#update?`.
+- name policies using the corresponding singular resource name (model name) with a `Policy` suffix, e.g. `Post -> PostPolicy`;
+- name rules using a predicate form of the corresponding activity (typically, a controller's action), e.g. `PostsController#update -> PostPolicy#update?`.
We also recommend to use an application-specific `ApplicationPolicy` with a global configuration to inherit from:
```ruby
class ApplicationPolicy < ActionPolicy::Base