docs/SUSPENSION.md in lite-regulations-1.1.2 vs docs/SUSPENSION.md in lite-regulations-1.2.0
- old
+ new
@@ -1,22 +1,21 @@
# Suspension
-#### Usage
+#### Table
```ruby
-# 1. Add column to table
class AddRegulationsTimestampColumn < ActiveRecord::Migration
def change
t.datetime :suspended_at
-
- # - or -
-
add_column :your_model, :suspended_at, :datetime
end
end
+```
-# 2. Include module
+#### Usage
+
+```ruby
class User < ActiveRecord::Base
include Lite::Regulations::Suspension
end
```
@@ -24,13 +23,11 @@
```ruby
user = User.first
user.unsuspend!
user.unsuspended? #=> true
-
user.suspend!
user.suspended? #=> true
-
user.to_suspension #=> Returns the visibility state locale string (ex: Suspended)
```
#### Scopes