README.md in mongoid-locker-0.3.5 vs README.md in mongoid-locker-0.3.6
- old
+ new
@@ -3,12 +3,16 @@
[](http://travis-ci.org/mongoid/mongoid-locker)
[](https://codeclimate.com/github/mongoid/mongoid-locker)
Document-level locking for MongoDB via Mongoid. The need arose at [Jux](https://jux.com) from multiple processes on multiple servers trying to act upon the same document and stepping on each other's toes. Mongoid-Locker is an easy way to ensure only one process can perform a certain operation on a document at a time.
-[Tested](http://travis-ci.org/mongoid/mongoid-locker) against MRI 2.3.1 with Mongoid 2, 3, 4, 5 and 6. See [.travis.yml](.travis.yml) for the latest test matrix.
+[Tested](http://travis-ci.org/mongoid/mongoid-locker) against:
+- MRI: `2.3.6`, `2.4.3`, `2.5.0`
+- Mongoid: `2`, `3`, `4`, `5`, `6`, `7`
+See [.travis.yml](.travis.yml) for the latest test matrix.
+
## Usage
Add to your `Gemfile`:
```ruby
@@ -36,25 +40,25 @@
queue_item.completed_at = Time.now
queue_item.save!
end
```
-`#with_lock` takes an optional [handful of options around retrying](http://rdoc.info/github/mongoid/mongoid-locker/Mongoid/Locker:with_lock), so make sure to take a look.
+The `#with_lock` function takes an optional [handful of options around retrying](http://rdoc.info/github/mongoid/mongoid-locker/Mongoid/Locker:with_lock), so make sure to take a look.
The default timeout can also be set on a per-class basis:
```ruby
class QueueItem
# ...
timeout_lock_after 10
end
```
-Note that these locks are only enforced when using `#with_lock`, not at the database level. It is useful for transactional operations, where you can make atomic modification of the document with checks. For exmple, you could deduct a purchase from a user's balance... _unless_ they are broke.
+Note that these locks are only enforced when using `#with_lock`, not at the database level. It's useful for transactional operations, where you can make atomic modification of the document with checks. For example, you could deduct a purchase from a user's balance ... _unless_ they are broke.
-More in-depth method documentation can be found at [rdoc.info](http://rdoc.info/github/mongoid/mongoid-locker/frames). Enjoy!
+More in-depth method documentation can be found at [rdoc.info](http://rdoc.info/github/mongoid/mongoid-locker/frames).
## Copyright & License
-Copyright (c) 2012-2017 Aidan Feldman & Contributors
+Copyright (c) 2012-2018 Aidan Feldman & Contributors
MIT License, see [LICENSE](LICENSE.txt) for more information.