diff --git a/README b/README deleted file mode 100644 index 94a34fca..00000000 --- a/README +++ /dev/null @@ -1,18 +0,0 @@ --*- markdown -*- -# Casbah -## formerly "mongo-scala-wrappers" -### Brendan W. McAdams - -Interfaces for [MongoDB][MongoDB] to be more flexibly accessible from both Java and Scala. Most specifically focused on providing a Scala oriented wrapper interface around the Java mongo driver. - -For the Scala side, contains series of wrappers and DSL-like functionality for utilizing MongoDB from within Scala. This currently utilises the very Java-oriented Mongo Java driver, and attempts to provide more scala-like functionality on top of it. This has been tested with MongoDB 1.2.x+ and v2.x of the Mongo java driver. - -This code is available at both [GitHub][GitHub] and [BitBucket][BitBucket]. BitBucket is the primary repository, with clones pushed to GitHub on a regular basis. - -GitHub kindly hosts our [Documentation][Documentation] including the [API Docs][API Docs] - - [mongodb]: http://mongodb.org "MongoDB" - [bitbucket]: http://bitbucket.org/novus/casbah "Casbah on BitBucket" - [github]: http://github.com/novus/casbah "Casbah on GitHub" - [api docs]: http://novus.github.com/docs/casbah/api/ "API Docs on GitHub" - [documentation]: http://novus.github.com/docs/casbah/ "Docs on GitHub" diff --git a/README.md b/README.md index 02bb8520..bef2c536 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ # Casbah ## formerly "mongo-scala-wrappers" ### Brendan W. McAdams +### Max Afonov -Interfaces for [MongoDB][MongoDB] to be more flexibly accessible from both Java and Scala. Most specifically focused on providing a Scala oriented wrapper interface around the Java mongo driver. +Casbah is an interface for [MongoDB][MongoDB] designed to provide more flexible access from both Java and Scala. While the current cor focus is on providing a Scala oriented wrapper interface around the Java mongo driver, support for other JVM languages may come in the future. For the Scala side, contains series of wrappers and DSL-like functionality for utilizing MongoDB from within Scala. This currently utilises the very Java-oriented Mongo Java driver, and attempts to provide more scala-like functionality on top of it. This has been tested with MongoDB 1.2.x+ and v2.x of the Mongo java driver. -This code is available at both [GitHub][GitHub] and [BitBucket][BitBucket]. BitBucket is the primary repository, with clones pushed to GitHub on a regular basis. +We are constantly adding new functionality, and maintain a detailed [Tutorial][Tutorial]. -GitHub kindly hosts our [Documentation][Documentation] including the [API Docs][API Docs] +Please report any issues at our [Lighthouse Issue Tracker](http://novus.lighthouseapp.com/projects/57054-casbah/overview), or post to the [Casbah Mailing List][mongodb-casbah-users] on Google Groups. + +GitHub kindly hosts our [Documentation][Documentation] including the [API Docs][API Docs] & [Tutorial][Tutorial]. [mongodb]: http://mongodb.org "MongoDB" - [bitbucket]: http://bitbucket.org/novus/casbah "Casbah on BitBucket" [github]: http://github.com/novus/casbah "Casbah on GitHub" [api docs]: http://novus.github.com/docs/casbah/api/ "API Docs on GitHub" [documentation]: http://novus.github.com/docs/casbah/ "Docs on GitHub" + [tutorial]: http://novus.github.com/docs/casbah/sphinx/html/intro/getting_started.html "Casbah Tutorial" + [mongodb-casbah-users]: http://groups.google.com/group/mongodb-casbah-users "Casbah Mailing List"