README.md in spidey-mongo-0.1.0 vs README.md in spidey-mongo-0.2.0
- old
+ new
@@ -3,20 +3,30 @@
This gem implements a [MongoDB](http://www.mongodb.org/) back-end for [Spidey](https://github.com/joeyAghion/spidey), a very simple framework for crawling and scraping web sites.
See [Spidey](https://githubcom/joeyAghion/spidey)'s documentation for a basic example spider class.
-The default implementation stores the queue of URLs being crawled, any generated results, and errors as attributes on the spider instance (i.e., in memory). By including this gem's `Spidey::Strategies::Mongo` module, spider implementations can store them in a MongoDB database instead.
+The default implementation stores the queue of URLs being crawled, any generated results, and errors as attributes on the spider instance (i.e., in memory). By including this gem's module, spider implementations can store them in a MongoDB database instead.
Usage
-----
### Install the gem
gem install spidey-mongo
+### `mongo` versus `moped`
+
+Spidey-Mongo provides two strategies:
+
+* `Spidey::Strategies::Mongo`: Compatible with 10gen's [`mongo`](https://github.com/mongodb/mongo-ruby-driver) gem
+* `Spidey::Strategies::Moped`: Compatible with the [`moped`](https://github.com/mongoid/moped) gem, e.g., for use with Mongoid 3.x
+
+You can include either strategy in your classes, as appropriate. All the examples in this README assume `Spidey::Strategies::Mongo`.
+
+
### Example spider class
class EbaySpider < Spidey::AbstractSpider
include Spidey::Strategies::Mongo
@@ -63,8 +73,17 @@
Testing
-------
bundle exec rspec
+Contributors
+------------
+
+[Joey Aghion](https://github.com/joeyAghion), [Frank Macreery](https://github.com/fancyremarker)
+
+To Do
+-----
+* Extract behaviors shared by `Mongo` and `Moped` strategies.
+
Copyright
---------
-Copyright (c) 2012 Joey Aghion, Art.sy Inc. See [LICENSE.txt](LICENSE.txt) for further details.
\ No newline at end of file
+Copyright (c) 2012, 2013 Joey Aghion, Artsy Inc. See [LICENSE.txt](LICENSE.txt) for further details.