README.md in mongoid-archivable-0.1.0 vs README.md in mongoid-archivable-1.0.0
- old
+ new
@@ -24,20 +24,20 @@
```
include Mongoid::Archivable
```
-Now a `destroy` of a document will move the document to an Archive collection.
+Now a `destroy` of a document will move the document to an Archive collection, namespaced under the document you're destroying.
-## Development
+## Example
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+user = User.create! name: "Example User"
+user.destroy
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+User.count # => 0
+User::Archive.count # => 1
+```
-## Contributing
+## Development
-1. Fork it ( https://github.com/[my-github-username]/mongoid-archivable/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Please report any issues to the [GitHub issue tracker](https://github.com/Sign2Pay/mongoid-archivable/issues).