From 099b681ce7149ec43c9d6f0efc7dfb0a6665dd1e Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Mon, 10 Jan 2022 14:39:15 +0000 Subject: [PATCH] [DOCS] Updates README and adds CONTRIBUTING --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 33 +++++---------------------------- 2 files changed, 21 insertions(+), 28 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..30ccb81 --- /dev/null +++ b/CONTRIBUTING.md @@ -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). diff --git a/README.md b/README.md index aadfe23..317aca5 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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).