README.md in mongoid-archivable-1.0.0 vs README.md in mongoid-archivable-1.1.0
- old
+ new
@@ -1,9 +1,11 @@
# Mongoid::Archivable
Moves Mongoid documents to an archive instead of destroying them.
+[ ![Codeship Status for Sign2Pay/mongoid-archivable](https://codeship.com/projects/a6d39180-c4c7-0132-bf85-1a3509ce6b71/status?branch=master)](https://codeship.com/projects/74192)
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -26,16 +28,24 @@
include Mongoid::Archivable
```
Now a `destroy` of a document will move the document to an Archive collection, namespaced under the document you're destroying.
+You can restore an archive as well. Send the `.restore` message to it. For now the archived document is retained, but that might change in the future.
+
## Example
```
user = User.create! name: "Example User"
user.destroy
User.count # => 0
+User::Archive.count # => 1
+
+archived_user = User::Archive.last
+archived_user.restore
+
+User.count # => 1
User::Archive.count # => 1
```
## Development