README.md in mongoid-ids-0.1.7 vs README.md in mongoid-ids-0.1.8
- old
+ new
@@ -1,18 +1,22 @@
-# Mongoid::Ids
-[](https://codeclimate.com/github/nofxx/mongoid-ids)
+Mongoid::Ids
+============
+
+[](http://badge.fury.io/rb/mongoid-ids)
[](https://gemnasium.com/nofxx/mongoid-ids)
[](http://travis-ci.org/nofxx/mongoid-ids)
+[](https://codeclimate.com/github/nofxx/mongoid-ids)
+[](https://coveralls.io/r/nofxx/mongoid-ids)
## Mongoid::Token || Mongoid::Ids
-This gem is a fork that changes the default behaviour of original
-Mongoid::Token: instead of custom fields it changes _id by default.
-But you may still use tokens on custom fields.
+This gem is a fork that changes the original behaviour of Mongoid::Token:
+Instead of a custom field it changes the `_id` field by default.
+And you may still use tokens on custom fields.
-## Short snappy tokens for Mongoid documents
+## Short snappy token ids for Mongoid documents
This library is a quick and simple way to generate unique, random ids
for your mongoid documents, in the cases where you can't, or don't want
to use slugs, or the default MongoDB ObjectIDs.
@@ -48,10 +52,13 @@
And that's it! There's lots of configuration options too - which are all
listed [below](#configuration). By default, the `token` method will
create tokens 4 characters long, containing random alphanumeric characters.
+**Notice: Every Mongoid overriding has been removed (#find and #to_param).**
+
+
## Custom/Extra fields
```ruby
class Person
@@ -212,11 +219,10 @@
token retry_count: 0
```
# Notes
-This gem just changes the Mongoid::Token behaviour, use it if you don't
-need to change ids:
+This gem just changes the Mongoid::Token behaviour, which is found at:
http://github.com/thetron/mongoid_token
If you find a problem, please [submit an issue](http://github.com/nofxx/mongoid-ids/issues) (and a failing test, if
you can). Pull requests and feature requests are always welcome and