Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 157 lines (89 sloc) 4.526 kb
b18e33d @michaelklishin Reorganize README
michaelklishin authored
1 # Elastisch, a Clojure client for ElasticSearch
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
2
d8c96c8 README updates
Michael Klishin authored
3 Elastisch is a minimalistic [Clojure client for
abfab49 README updates
Michael Klishin authored
4 ElasticSearch](http://clojureelasticsearch.info), a modern distributed search engine.
c524b37 @ifesdjeen Adding readme & travis
ifesdjeen authored
5
e1965b9 @michaelklishin README update
michaelklishin authored
6
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
7 ## Project Goals
8
9c3079b @michaelklishin README updates
michaelklishin authored
9 * Be reasonably feature complete
a727362 @michaelklishin 1.0.0-rc1
michaelklishin authored
10 * Be [well documented](http://clojureelasticsearch.info)
523a08a @ahjones Point to the right URL for the test directory
ahjones authored
11 * Be [well tested](https://github.com/clojurewerkz/elastisch/tree/master/test)
a727362 @michaelklishin 1.0.0-rc1
michaelklishin authored
12 * Closely follow [ElasticSearch API structure](http://www.elasticsearch.org/guide/reference/api/), no new abstractions introduced
8900cec README updates
Michael Klishin authored
13 * Support multiple transports: HTTP, native ES client, possibly more (e.g. Memcached)
2a17539 @michaelklishin README update
michaelklishin authored
14 * Follow recent ElasticSearch releases & developments
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
15
16
e1965b9 @michaelklishin README update
michaelklishin authored
17 ## Community
18
d8c96c8 README updates
Michael Klishin authored
19 [Elastisch has a mailing
20 list](https://groups.google.com/forum/#!forum/clojure-elasticsearch). Feel
21 free to join it and ask any questions you may have.
e1965b9 @michaelklishin README update
michaelklishin authored
22
d8c96c8 README updates
Michael Klishin authored
23 To subscribe for announcements of releases, important changes and so
24 on, please follow [@ClojureWerkz](https://twitter.com/#!/clojurewerkz)
25 on Twitter.
e1965b9 @michaelklishin README update
michaelklishin authored
26
27
28
aeea94a @michaelklishin README update
michaelklishin authored
29 ## Project Maturity
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
30
8900cec README updates
Michael Klishin authored
31 Elastisch is a not a young project. Started in late 2011, it has been used
9aa94ab @michaelklishin Do I even English
michaelklishin authored
32 in production since the early days. Elastisch API is stable. 1.0 was
57767aa @michaelklishin More README edits
michaelklishin authored
33 released in September 2012, 2.0 in June 2014, 2.1 in December 2014.
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
34
35
36 ## Artifacts
c524b37 @ifesdjeen Adding readme & travis
ifesdjeen authored
37
e71bf4d @michaelklishin 1.0.0 RC2
michaelklishin authored
38 Elastisch artifacts are [released to Clojars](https://clojars.org/clojurewerkz/elastisch).
39
40 If you are using Maven, add the following repository definition to your `pom.xml`:
41
42 ``` xml
43 <repository>
44 <id>clojars.org</id>
45 <url>http://clojars.org/repo</url>
46 </repository>
47 ```
48
49 ### The Most Recent Release
50
e1965b9 @michaelklishin README update
michaelklishin authored
51 With Leiningen:
52
a9ee890 @michaelklishin beta3 is out
michaelklishin authored
53 [clojurewerkz/elastisch "2.2.0-beta3"]
e1965b9 @michaelklishin README update
michaelklishin authored
54
55
56 With Maven:
57
58 <dependency>
59 <groupId>clojurewerkz</groupId>
60 <artifactId>elastisch</artifactId>
a9ee890 @michaelklishin beta3 is out
michaelklishin authored
61 <version>2.2.0-beta3</version>
81e3793 Add 1.1.0 beta artifacts info to the README
Michael Klishin authored
62 </dependency>
63
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
64
a727362 @michaelklishin 1.0.0-rc1
michaelklishin authored
65
66 ## Documentation & Examples
67
68 Please see our [documentation guides site](http://clojureelasticsearch.info/).
69
70 Our [test suite](https://github.com/clojurewerkz/elastisch/tree/master/test/clojurewerkz/elastisch) also has many code examples.
71
72
73
d8c96c8 README updates
Michael Klishin authored
74 ## Supported Clojure Versions
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
75
dcb2027 @michaelklishin Require 1.6
michaelklishin authored
76 Elastisch requires Clojure 1.6.
d8c96c8 README updates
Michael Klishin authored
77 The most recent stable release is highly recommended.
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
78
5be6425 @michaelklishin Make it clear what ES versions are known to work
michaelklishin authored
79 ## Supported ElasticSearch Versions
80
309dc7a @michaelklishin Update supported ElasticSearch versions section
michaelklishin authored
81 Elastisch 2.1 targets ElasticSearch 1.1+.
5be6425 @michaelklishin Make it clear what ES versions are known to work
michaelklishin authored
82
309dc7a @michaelklishin Update supported ElasticSearch versions section
michaelklishin authored
83 Elastisch 2.0 **requires** [ElasticSearch 1.x](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/breaking-changes.html).
5be6425 @michaelklishin Make it clear what ES versions are known to work
michaelklishin authored
84
540e2b5 @michaelklishin New README more in line with what other Clojurewerkz projects (Monger…
michaelklishin authored
85
abfab49 README updates
Michael Klishin authored
86 ## REST and Native Clients
87
ab48ced README updates
Michael Klishin authored
88 Elastisch provides HTTP and native (transport) clients with nearly
89 identical API as of `1.1.0`.
abfab49 README updates
Michael Klishin authored
90
91
92
9c3079b @michaelklishin README updates
michaelklishin authored
93 ## Elastisch Is a ClojureWerkz Project
94
78e29a7 link to clojurewerkz.org
Michael Klishin authored
95 Elastisch is part of the group of [Clojure libraries](http://clojurewerkz.org) known as ClojureWerkz, together with
d8c96c8 README updates
Michael Klishin authored
96
faeac26 @sopel Fix ClojureWerkz library links
sopel authored
97 * [Langohr](http://clojurerabbitmq.info)
08f941a @michaelklishin Update sister project list
michaelklishin authored
98 * [Cassaforte](http://clojurecassandra.info)
99 * [Monger](http://clojuremongodb.info)
faeac26 @sopel Fix ClojureWerkz library links
sopel authored
100 * [Neocons](http://clojureneo4j.info)
101 * [Quartzite](http://clojurequartz.info)
102 * [Titanium](http://titanium.clojurewerkz.org)
d8c96c8 README updates
Michael Klishin authored
103
104 and several others.
d08ef26 @ifesdjeen Adding more reasonable tests and some comments.
ifesdjeen authored
105
106
90395e2 @michaelklishin Tweak our goalth
michaelklishin authored
107 ## Continuous Integration
108
109 [![Continuous Integration status](https://secure.travis-ci.org/clojurewerkz/elastisch.png)](http://travis-ci.org/clojurewerkz/elastisch)
edde6ce @podviaznikov Update README.md
podviaznikov authored
110 [![Dependencies Status](http://jarkeeper.com/clojurewerkz/elastisch/status.svg)](http://jarkeeper.com/clojurewerkz/elastisch)
d08ef26 @ifesdjeen Adding more reasonable tests and some comments.
ifesdjeen authored
111
eba2637 @michaelklishin Migrate to Leiningen 2
michaelklishin authored
112 ## Development
113
d8c96c8 README updates
Michael Klishin authored
114 ### ElasticSearch Setup
115
116 Elastisch needs ElasticSearch running locally (`127.0.0.1`). `ES_CLUSTER_NAME` need to be exported
117 with the name of the local cluster. To find it out, use
118
119 ```
120 curl http://localhost:9200/_cluster/nodes
121 ```
122
b1e087a Rearrange sections related to development
Michael Klishin authored
123 ### Running Tests
124
125 To run Elastisch tests, make sure you have ElasticSearch running. It must be the same
126 version that Elastisch depends on due to binary protocol changes between releases.
127 [project.clj](project.clj) or [project page on Clojars](https://clojars.org/clojurewerkz/elastisch)
128 can help find that out.
129
130 Finally, run all tests with
131
132 lein all test
133
134 To run only HTTP client tests, use
135
136 lein all test :ci
137
138
d8c96c8 README updates
Michael Klishin authored
139 ### Leiningen
140
eba2637 @michaelklishin Migrate to Leiningen 2
michaelklishin authored
141 Elastisch uses [Leiningen 2](https://github.com/technomancy/leiningen/blob/master/doc/TUTORIAL.md). Make
cc76324 @michaelklishin Clojure 1.4.0
michaelklishin authored
142 sure you have it installed and then run tests against all supported Clojure versions using
eba2637 @michaelklishin Migrate to Leiningen 2
michaelklishin authored
143
4baed7c @michaelklishin lein2 => lein
michaelklishin authored
144 lein all test
eba2637 @michaelklishin Migrate to Leiningen 2
michaelklishin authored
145
d8c96c8 README updates
Michael Klishin authored
146 Then create a branch and make your changes on it. Once you are done
147 with your changes and all tests pass, submit a pull request on GitHub.
eba2637 @michaelklishin Migrate to Leiningen 2
michaelklishin authored
148
149
150
8872715 @ifesdjeen Adding Readme
ifesdjeen authored
151 ## License
152
0db3d81 @michaelklishin (c) year
michaelklishin authored
153 Copyright (C) 2011-2015 Alex Petrov, Michael S. Klishin, and the ClojureWerkz Team.
8872715 @ifesdjeen Adding Readme
ifesdjeen authored
154
53aef87 @michaelklishin Double-license under EPL and APL2
michaelklishin authored
155 Double-licensed under the [Eclipse Public License](https://www.eclipse.org/legal/epl-v10.html) (the same as Clojure) and
156 [Apache Public License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
Something went wrong with that request. Please try again.