Skip to content
This repository has been archived by the owner on Aug 24, 2022. It is now read-only.

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ngrunwald committed Feb 22, 2013
1 parent de308f8 commit f2ed76d
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
@@ -1,14 +1,14 @@
# clj-elasticsearch

A clojure wrapper around the native Java elasticsearch API. It aims to be as idiomatic as possible while remaining fast.
A clojure wrapper around the native [Java elasticsearch API](http://www.elasticsearch.org/guide/reference/java-api/). It aims to be as idiomatic as possible while remaining fast and complete.

The API docs are available [here](http://ngrunwald.github.com/clj-elasticsearch).

## Installation

`clj-elasticsearch` is available as a Maven artifact from [Clojars](http://clojars.org/clj-elasticsearch).

However, the elasticsearch artefact must also be included, and as a rule of thumb you should always pull exactly the same version of the artifact as the one used by the server to which you want to connect. Otherwise, you might get strange compatibility bugs, especially with the `Node` client.
However, the elasticsearch artefact must also be included, and as a rule of thumb you should always pull exactly the same version of the artifact as the one used by the server to which you want to connect (or at the very least the same major version, according to the [docs](http://www.elasticsearch.org/guide/reference/java-api/client.html)). Otherwise, you might get strange compatibility bugs, especially with the `Node` client.

```clojure
[clj-elasticsearch "0.4.0-RC1"]
Expand Down Expand Up @@ -53,21 +53,25 @@ or in a simpler way by setting `:async?` to `true` and dereferencing the returne
```
In this case, if the request was a failure, the corresponding Exception will be thrown when you `deref` the returned future. You can try/catch it as usual. You can also use 3-args version of `deref` to give a timeout to the request.

A bit more details on usage can be found in the tests.
A bit more details on usage can be found in the [tests](https://github.com/ngrunwald/clj-elasticsearch/blob/master/test/clj_elasticsearch/test/client.clj).

## Compatibility

`clj-elasticsearch` is tested from elasticsearch `0.19.0` onward. It might or might not work on older versions.

## Related Posts and Info

* [Release Post](http://theblankscreen.net/blog/2013/02/22/first-public-release-of-clj-elasticsearch/) Some information on the how and why of this client

## See Also

For other elasticsearch Clojure clients:

* [elastisch](https://github.com/clojurewerkz/elastisch): An idiomatic Clojure wrapper for the HTTP API
* [esearch](https://github.com/mpenet/clj-esearch): An asynchronous client for the HTTP API
* [Elastisch](https://github.com/clojurewerkz/elastisch): An idiomatic Clojure wrapper for the HTTP API
* [Esearch](https://github.com/mpenet/clj-esearch): An asynchronous client for the HTTP API

## License

Copyright (C) 2012, 2013 [Linkfluence](http://linkfluence.net)
Copyright (C) 2012, 2013 [Linkfluence](http://us.linkfluence.net)

Distributed under the Eclipse Public License, the same as Clojure.

0 comments on commit f2ed76d

Please sign in to comment.