Skip to content

Commit 099b681

Browse files
committed
[DOCS] Updates README and adds CONTRIBUTING
1 parent 43a75aa commit 099b681

File tree

2 files changed

+21
-28
lines changed

2 files changed

+21
-28
lines changed

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
To work on the code, clone the repository and install the dependencies:
2+
3+
```
4+
git clone https://github.com/elasticsearch/elasticsearch-dsl-ruby.git
5+
cd elasticsearch-dsl/
6+
bundle install
7+
```
8+
9+
Use the Rake tasks to run the test suites:
10+
11+
```
12+
bundle exec rake test:unit
13+
bundle exec rake test:integration
14+
```
15+
16+
To launch a separate Elasticsearch server for integration tests, see instructions in the [Elasticsearch Ruby Client](https://github.com/elastic/elasticsearch-ruby/blob/main/CONTRIBUTING.md).

README.md

+5-28
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Elasticsearch::DSL
22

3-
The `elasticsearch-dsl` library provides a Ruby API for
4-
the [Elasticsearch Query DSL](http://www.elasticsearch.com/guide/en/elasticsearch/reference/current/query-dsl.html).
5-
6-
The library is compatible with Ruby 1.9 or higher and Elasticsearch 1.0 and higher.
3+
The `elasticsearch-dsl` library provides a Ruby API for the [Elasticsearch Query DSL](http://www.elasticsearch.com/guide/en/elasticsearch/reference/current/query-dsl.html).
74

85
## Installation
96

@@ -13,12 +10,12 @@ Install the package from [Rubygems](https://rubygems.org):
1310

1411
To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
1512

16-
gem 'elasticsearch-dsl', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
13+
gem 'elasticsearch-dsl', git: 'git://github.com/elasticsearch/elasticsearch-dsl-ruby.git'
1714

1815
or install it from a source code checkout:
1916

20-
git clone https://github.com/elasticsearch/elasticsearch-ruby.git
21-
cd elasticsearch-ruby/elasticsearch-dsl
17+
git clone https://github.com/elasticsearch/elasticsearch-dsl-ruby.git
18+
cd elasticsearch-dsl-ruby
2219
bundle install
2320
rake install
2421

@@ -290,24 +287,4 @@ s.to_hash
290287

291288
## Development
292289

293-
To work on the code, clone the repository and install the dependencies:
294-
295-
```
296-
git clone https://github.com/elasticsearch/elasticsearch-ruby.git
297-
cd elasticsearch-ruby/elasticsearch-dsl/
298-
bundle install
299-
```
300-
301-
Use the Rake tasks to run the test suites:
302-
303-
```
304-
bundle exec rake test:unit
305-
bundle exec rake test:integration
306-
```
307-
308-
To launch a separate Elasticsearch server for integration tests,
309-
see instructions in the main [README](../README.md#development).
310-
311-
## License
312-
313-
This software is licensed under the [Apache 2 license](./LICENSE).
290+
See [CONTRIBUTING](https://github.com/elastic/elasticsearch-dsl-ruby/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)