You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-24
Original file line number
Diff line number
Diff line change
@@ -8,44 +8,50 @@ This repository contains the official [Elasticsearch](https://www.elastic.co/pro
8
8
9
9
## Documentation
10
10
11
-
Please refer to [the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html) for comprehensive information.
11
+
Please refer to
12
+
[the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html)
13
+
for comprehensive information.
12
14
13
-
Both `elastic-transport` and `elasticsearch-api` are also documented. You can check the [`elastic-transport`](https://rubydoc.info/github/elastic/elastic-transport-ruby/) and the [`elasticsearch-api`](http://rubydoc.info/gems/elasticsearch-api) documentation at RubyDocs.
15
+
Both `elastic-transport` and `elasticsearch-api` are documented. You can check
16
+
the [`elastic-transport`](https://rubydoc.info/github/elastic/elastic-transport-ruby/)
17
+
and the [`elasticsearch-api`](http://rubydoc.info/gems/elasticsearch-api)
18
+
documentation at RubyDocs.
14
19
15
20
## Installation
16
21
17
-
Install the `elasticsearch` gem from [Rubygems](https://rubygems.org/gems/elasticsearch):
18
-
19
-
```
20
-
$ gem install elasticsearch
21
-
```
22
-
23
-
Or add it to your project's Gemfile:
24
-
25
22
```ruby
26
-
gem 'elasticsearch', 'VERSION'
23
+
gem install elasticsearch
27
24
```
28
25
29
-
## Usage example
30
-
31
-
```ruby
32
-
require'elasticsearch'
33
-
34
-
client =Elasticsearch::Client.new(log:true)
26
+
Refer to the [Installation section](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/getting-started-ruby.html#_installation)
See also [the official documentation](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/examples.html) for examples of how to use the most frequently called APIs and [`doc/examples`](https://github.com/elastic/elasticsearch-ruby/blob/main/docs/examples/) for some practical examples.
43
+
*[Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/getting-started-ruby.html#_creating_an_index)
44
+
*[Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/getting-started-ruby.html#_indexing_documents)
**For optimal performance, you should use a HTTP library which supports persistent ("keep-alive") connections, e.g. [Patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus).** These libraries are not dependencies of the Elasticsearch gems. Ensure you define a dependency for a HTTP library in your own application.
0 commit comments