monger/README.md

# Monger

Monger is an idiomatic Clojure wrapper around MongoDB Java driver.


## Project Goals

There is one MongoDB client for Clojure that has been around since 2009. So, why create another one? Monger authors
wanted a client that will

 * Support most of MongoDB 2.0+ features but only those that really matter. Grouping the way it is done today, for example, does not (it is easier to just use Map/Reduce directly).
 * Be well documented.
 * Be well tested.
 * Be maintained, not carry technical debt from 2009 on and on.
 * Will integrate usage of JavaScript files and ClojureScript (as soon as the compiler gets artifact it is possible to depend on for easy embedding).
 * Will learn from other clients like the Java and Ruby ones.
 * Will target Clojure 1.3.0 and later from the ground up.

## Usage

Before documentation guides & examples are written (targeted for the 1.0 release), it is fair to say that it is *likely to be unusable* to anyone
other than the author.


## This is a Work In Progress

Core Monger APIs are stabilized but it is still a work in progress. Keep that in mind. 1.0 will be released in late 2011.


## Artifacts

Snapshot artifacts are [released to Clojars](https://clojars.org/com.novemberain/monger) every few days.

With Leiningen:

    [com.novemberain/monger "0.11.0-SNAPSHOT"]


With Maven:

    <dependency>
      <groupId>com.novemberain</groupId>
      <artifactId>monger</artifactId>
      <version>0.11.0-SNAPSHOT</version>
    </dependency>


## Continuous Integration

[![Continuous Integration status](https://secure.travis-ci.org/michaelklishin/monger.png)](http://travis-ci.org/michaelklishin/monger)


CI is hosted by [travis-ci.org](http://travis-ci.org)


## Supported Clojure versions

Monger is built from the ground up for Clojure 1.3 and up.


## License

Copyright (C) 2011 Michael S. Klishin

Distributed under the [Eclipse Public License](http://www.eclipse.org/legal/epl-v10.html), the same as Clojure.
Update README in preparation to moving to a public repo 2011-09-11 10:28:38 +00:00			`# Monger`
Update README 2011-08-04 12:01:26 +00:00
Edited README.md via GitHub 2011-10-09 22:32:25 +00:00			`Monger is an idiomatic Clojure wrapper around MongoDB Java driver.`
Update README 2011-08-04 12:01:26 +00:00
Minor README update 2011-09-10 16:28:13 +00:00
Update README.md 2011-10-19 15:32:55 +00:00			`## Project Goals`

			`There is one MongoDB client for Clojure that has been around since 2009. So, why create another one? Monger authors`
			`wanted a client that will`

			`* Support most of MongoDB 2.0+ features but only those that really matter. Grouping the way it is done today, for example, does not (it is easier to just use Map/Reduce directly).`
			`* Be well documented.`
			`* Be well tested.`
			`* Be maintained, not carry technical debt from 2009 on and on.`
			`* Will integrate usage of JavaScript files and ClojureScript (as soon as the compiler gets artifact it is possible to depend on for easy embedding).`
			`* Will learn from other clients like the Java and Ruby ones.`
			`* Will target Clojure 1.3.0 and later from the ground up.`

Update README 2011-08-04 12:01:26 +00:00			`## Usage`

Edited README.md via GitHub 2011-10-12 11:18:54 +00:00			`Before documentation guides & examples are written (targeted for the 1.0 release), it is fair to say that it is likely to be unusable to anyone`
Update README in preparation to moving to a public repo 2011-09-11 10:28:38 +00:00			`other than the author.`
Update README 2011-08-04 12:01:26 +00:00
Starting adding samples. 2011-09-08 20:27:49 +00:00
Update README in preparation to moving to a public repo 2011-09-11 10:28:38 +00:00			`## This is a Work In Progress`
Starting adding samples. 2011-09-08 20:27:49 +00:00
Update README.md 2011-10-19 15:32:55 +00:00			`Core Monger APIs are stabilized but it is still a work in progress. Keep that in mind. 1.0 will be released in late 2011.`
Minor README update 2011-09-10 16:28:13 +00:00

Mention artifacts in the README [ci skip] 2011-10-09 12:56:10 +00:00			`## Artifacts`

			`Snapshot artifacts are [released to Clojars](https://clojars.org/com.novemberain/monger) every few days.`

			`With Leiningen:`

0.11.0-SNAPSHOT is now available from clojars 2011-10-13 14:13:42 +00:00			`[com.novemberain/monger "0.11.0-SNAPSHOT"]`
Mention artifacts in the README [ci skip] 2011-10-09 12:56:10 +00:00

			`With Maven:`

			`<dependency>`
			`<groupId>com.novemberain</groupId>`
			`<artifactId>monger</artifactId>`
0.11.0-SNAPSHOT is now available from clojars 2011-10-13 14:13:42 +00:00			`<version>0.11.0-SNAPSHOT</version>`
Mention artifacts in the README [ci skip] 2011-10-09 12:56:10 +00:00			`</dependency>`


Of course we will be using travis-ci.org 2011-09-11 10:40:15 +00:00			`## Continuous Integration`

			`[![Continuous Integration status](https://secure.travis-ci.org/michaelklishin/monger.png)](http://travis-ci.org/michaelklishin/monger)`


			`CI is hosted by [travis-ci.org](http://travis-ci.org)`



Update README in preparation to moving to a public repo 2011-09-11 10:28:38 +00:00			`## Supported Clojure versions`

			`Monger is built from the ground up for Clojure 1.3 and up.`
Starting adding samples. 2011-09-08 20:27:49 +00:00

Update README 2011-08-04 12:01:26 +00:00			`## License`

Update license information I am considering doing first public release soon and for now, it is better to keep it unaffiliated with any particular company 2011-09-11 07:32:46 +00:00			`Copyright (C) 2011 Michael S. Klishin`
Update README 2011-08-04 12:01:26 +00:00
Link to the EPL 2011-10-16 13:03:14 +00:00			`Distributed under the [Eclipse Public License](http://www.eclipse.org/legal/epl-v10.html), the same as Clojure.`