Skip to content

Commit 0487bb2

Browse files
committed
Updated README, rockspec and added LICENSE
1 parent 9b132b6 commit 0487bb2

File tree

3 files changed

+48
-19
lines changed

3 files changed

+48
-19
lines changed

LICENSE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
Copyright © 2015-2016 Dhaval Kapil <[email protected]>
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the “Software”), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in
12+
all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20+
THE SOFTWARE.

README.md

+26-17
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,45 @@
11
# elasticsearch-lua
22

3-
[![Build Status](https://travis-ci.org/DhavalKapil/elasticsearch-lua.svg?branch=master)](https://travis-ci.org/DhavalKapil/elasticsearch-lua) [![Coverage Status](https://coveralls.io/repos/github/DhavalKapil/elasticsearch-lua/badge.svg?branch=master)](https://coveralls.io/github/DhavalKapil/elasticsearch-lua?branch=master)
3+
[![Build Status](https://travis-ci.org/DhavalKapil/elasticsearch-lua.svg?branch=2.x.y)](https://travis-ci.org/DhavalKapil/elasticsearch-lua) [![Coverage Status](https://coveralls.io/repos/github/DhavalKapil/elasticsearch-lua/badge.svg?branch=2.x.y)](https://coveralls.io/github/DhavalKapil/elasticsearch-lua?branch=2.x.y)
44

5-
> A simple low level client for elasticsearch written in lua.
5+
[![Join the chat at https://gitter.im/DhavalKapil/elasticsearch-lua](https://badges.gitter.im/DhavalKapil/elasticsearch-lua.svg)](https://gitter.im/DhavalKapil/elasticsearch-lua?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
6+
7+
[![LuaRocks](https://img.shields.io/badge/LuaRocks-2.4.1-blue.svg)](https://luarocks.org/modules/dhavalkapil/elasticsearch) [![Lua](https://img.shields.io/badge/Lua-5.1%2C%20JIT%2C%205.2%2C%205.3-blue.svg)](https://img.shields.io/badge/Lua-5.1%2C%20JIT%2C%205.2%2C%205.3-blue.svg)
8+
9+
A low level client for Elasticsearch written in Lua.
610

711
In accordance with other official low level clients, the client accepts associative arrays in the form of lua table as parameters.
812

913
## Features:
1014

11-
1. One-to-one mapping with REST API and other language clients
15+
1. One-to-one mapping with REST API and other language clients.
1216
2. Proper load balancing across all nodes.
13-
3. Pluggable and multiple selection strategies and connection pool.
17+
3. Pluggable and multiple connection, selection strategies and connection pool.
1418
4. Console logging facility.
1519
5. Almost every parameter is configurable.
1620

17-
## Requirements
21+
## Elasticsearch Version Matrix
1822

19-
`elasticsearch-lua` works for lua >= 5.1 version.
23+
| Elasticsearch Version | elasticsearch-lua Branch |
24+
| --------------------- | ------------------------ |
25+
| >= 2.0, < 5.0 | 2.x.y |
2026

21-
It has been successfully tested for elasticsearch version 1.6.
27+
## Lua Version Requirements
2228

23-
## Setup
29+
`elasticsearch-lua` works for lua >= 5.1 version.
2430

25-
1. Clone this repository and `cd` to it.
26-
2. Download and install ``luarocks``. Follow [these](https://github.com/keplerproject/luarocks/wiki/Installation-instructions-for-Unix) steps. Make sure to change lua's version to 5.3 while installation(default is 5.1).
27-
3. Install dependencies:
28-
```
29-
[sudo] luarocks install elasticsearch-scm-0.rockspec
30-
```
31-
4. Add the source directory to your lua program's `package.path`.
31+
## Setup
3232

33-
OR
33+
It can be installed using [luarocks](https://luarocks.org)
3434

35-
It can also be installed using luarocks
3635
```
3736
[sudo] luarocks install --server=http://luarocks.org/manifests/dhavalkapil elasticsearch
3837
```
3938

4039
## Documentation
4140

41+
The complete documetation is [here](http://elasticsearch-lua.readthedocs.io/).
42+
4243
### Create elasticsearch client instance:
4344

4445
```lua
@@ -166,3 +167,11 @@ data, err = client:update{
166167
}
167168
}
168169
```
170+
171+
## Contribution
172+
173+
Feel free to [file issues](https://github.com/DhavalKapil/elasticsearch-lua/issues) and submit [pull requests](https://github.com/DhavalKapil/elasticsearch-lua/pulls) – contributions are welcome. Please try to follow the code style used in the repository.
174+
175+
## License
176+
177+
elasticsearch-lua is licensed under the [MIT license](https://dhaval.mit-license.org/2015/license.txt).

elasticsearch-scm-0.rockspec

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ source = {
66
description = {
77
summary = "Elasticsearch client for the Lua language",
88
detailed = [[
9-
This is an elasticsearch client written in Lua. Under development.
9+
This is an elasticsearch client written in Lua. In accordance with other official low level clients, the client accepts associative arrays in the form of lua table as parameters.
1010
]],
1111
homepage = "https://github.com/DhavalKapil/elasticsearch-lua",
12-
license = "Apache 2"
12+
license = "MIT"
1313
}
1414
dependencies = {
1515
"lua >= 5.1, < 5.4",

0 commit comments

Comments
 (0)