module level documentation to point to tutorials

This commit is contained in:
Scott R. Parish 2010-03-13 22:09:38 -06:00
parent ec768682e2
commit 442ed03027
2 changed files with 18 additions and 1 deletions

View file

@ -23,6 +23,23 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-} -}
-- | A driver for MongoDB
--
-- This module lets you connect to MongoDB, do inserts, queries,
-- updates, etc. Also has many convience functions inspired by HDBC
-- such as more easily converting between the BsonValue types and
-- native Haskell types.
--
-- * Tutorial for this driver:
-- <http://github.com/srp/mongoDB/blob/master/tutorial.md>
--
-- * Map/Reduce example for this driver:
-- <http://github.com/srp/mongoDB/blob/master/map-reduce-example.md>
--
-- * MongoDB:
-- <http://www.mongodb.org/>
--
module Database.MongoDB module Database.MongoDB
( (
-- * Connection -- * Connection

View file

@ -7,7 +7,7 @@ Copyright: Copyright (c) 2010-2010 Scott Parish
homepage: http://github.com/srp/mongoDB homepage: http://github.com/srp/mongoDB
Category: Database Category: Database
Synopsis: A driver for MongoDB Synopsis: A driver for MongoDB
Description: This driver lets you connect to MongoDB, do inserts, Description: This module lets you connect to MongoDB, do inserts,
queries, updates, etc. Also has many convience functions queries, updates, etc. Also has many convience functions
inspired by HDBC such as more easily converting between inspired by HDBC such as more easily converting between
the BsonValue types and native Haskell types. the BsonValue types and native Haskell types.