Skip to content

Commit

Permalink
[DOCS] Updates README and adds CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed Jan 10, 2022
1 parent 43a75aa commit 099b681
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 28 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
To work on the code, clone the repository and install the dependencies:

```
git clone https://github.com/elasticsearch/elasticsearch-dsl-ruby.git
cd elasticsearch-dsl/
bundle install
```

Use the Rake tasks to run the test suites:

```
bundle exec rake test:unit
bundle exec rake test:integration
```

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).
33 changes: 5 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Elasticsearch::DSL

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).

The library is compatible with Ruby 1.9 or higher and Elasticsearch 1.0 and higher.
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).

## Installation

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

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

gem 'elasticsearch-dsl', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
gem 'elasticsearch-dsl', git: 'git://github.com/elasticsearch/elasticsearch-dsl-ruby.git'

or install it from a source code checkout:

git clone https://github.com/elasticsearch/elasticsearch-ruby.git
cd elasticsearch-ruby/elasticsearch-dsl
git clone https://github.com/elasticsearch/elasticsearch-dsl-ruby.git
cd elasticsearch-dsl-ruby
bundle install
rake install

Expand Down Expand Up @@ -290,24 +287,4 @@ s.to_hash

## Development

To work on the code, clone the repository and install the dependencies:

```
git clone https://github.com/elasticsearch/elasticsearch-ruby.git
cd elasticsearch-ruby/elasticsearch-dsl/
bundle install
```

Use the Rake tasks to run the test suites:

```
bundle exec rake test:unit
bundle exec rake test:integration
```

To launch a separate Elasticsearch server for integration tests,
see instructions in the main [README](../README.md#development).

## License

This software is licensed under the [Apache 2 license](./LICENSE).
See [CONTRIBUTING](https://github.com/elastic/elasticsearch-dsl-ruby/blob/main/CONTRIBUTING.md).

0 comments on commit 099b681

Please sign in to comment.