luciano/monger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add API reference link to the README

Browse source
This commit is contained in:
Michael S. Klishin 2012-07-29 23:44:42 +04:00
parent 7eea7e229b
commit 8fdb7ee674
1 changed files with 14 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -13,13 +13,12 @@ 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). * 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](http://clojuremongodb.info). * Be [well documented](http://clojuremongodb.info).
* Be well tested. * Be [well tested](https://github.com/michaelklishin/monger/tree/master/test/monger/test).
* Be maintained, do not carry technical debt from 2009 forever. * Not carry technical debt from 2009 forever.
* Target Clojure 1.3.0 and later from the ground up. * Target Clojure 1.3.0 and later from the ground up.
* Be as close to the Mongo shell query language as practical
* Integrate with libraries like clojure.data.json, Joda Time, [Ragtime](https://github.com/weavejester/ragtime). * Integrate with libraries like clojure.data.json, Joda Time, [Ragtime](https://github.com/weavejester/ragtime).
* Provide support for unit testing: factories/fixtures DSL, collection cleaner functions, clojure.test integration and so on.
* Support URI connections to be friendly to Heroku and other PaaS providers. * Support URI connections to be friendly to Heroku and other PaaS providers.
* Learn from other clients like the Java and Ruby ones.
* Integrate usage of JavaScript files and ClojureScript (as soon as the compiler gets artifact it is possible to depend on for easy embedding). * Integrate usage of JavaScript files and ClojureScript (as soon as the compiler gets artifact it is possible to depend on for easy embedding).
@ -75,7 +74,9 @@ Please refer to our [Getting Started guide](http://clojuremongodb.info/articles/
## Documentation & Examples ## Documentation & Examples
Please visit our [documentation site](http://clojuremongodb.info/). Our [test suite](https://github.com/michaelklishin/monger/tree/master/test/monger/test) also has many code examples. Please see our [documentation guides site](http://clojuremongodb.info/) and [API reference](http://reference.clojuremongodb.info).
Our [test suite](https://github.com/michaelklishin/monger/tree/master/test/monger/test) also has many code examples.
@ -90,7 +91,14 @@ Monger is built from the ground up for Clojure 1.3 and up.
### Write Performance
## Monger Is a ClojureWerkz Project
Monger is part of the [group of Clojure libraries known as ClojureWerkz](http://clojurewerkz.org), together with
[Neocons](https://github.com/michaelklishin/neocons), [Langohr](https://github.com/michaelklishin/langohr), [Elastisch](https://github.com/clojurewerkz/elastisch), [Welle](https://github.com/michaelklishin/welle), [Quartzite](https://github.com/michaelklishin/quartzite) and several others.
## Write Performance
Monger insert operations are efficient and have very little overhead compared to the underlying Java driver. Here Monger insert operations are efficient and have very little overhead compared to the underlying Java driver. Here
are some numbers on a MacBook Pro from fall 2010 with Core i7 and an Intel SSD drive: are some numbers on a MacBook Pro from fall 2010 with Core i7 and an Intel SSD drive:
@ -109,12 +117,6 @@ With the `SAFE` write concern, it takes roughly 0.5 second to insert 100,000 doc
## Monger Is a ClojureWerkz Project
Monger is part of the [group of Clojure libraries known as ClojureWerkz](http://clojurewerkz.org), together with
[Neocons](https://github.com/michaelklishin/neocons), [Langohr](https://github.com/michaelklishin/langohr), [Elastisch](https://github.com/clojurewerkz/elastisch), [Welle](https://github.com/michaelklishin/welle), [Quartzite](https://github.com/michaelklishin/quartzite) and several others.
## Development ## Development
Monger uses [Leiningen 2](https://github.com/technomancy/leiningen/blob/master/doc/TUTORIAL.md). Make sure you have it installed and then run tests against Monger uses [Leiningen 2](https://github.com/technomancy/leiningen/blob/master/doc/TUTORIAL.md). Make sure you have it installed and then run tests against