Update README and links (#5)

Update README and links
This commit is contained in:
Tomas Della Vedova
2019-06-04 17:32:12 +02:00
committed by GitHub
3 changed files with 23 additions and 15 deletions

View File

@ -1 +1 @@
The changelog has moved to https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/changelog.html
The changelog has moved to https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/changelog.html

View File

@ -1,5 +1,13 @@
# elasticsearch.js 16.1.0
---
#### We have released the [new JavaScript client](https://www.elastic.co/blog/new-elasticsearch-javascript-client-released)!
*In the next months this client will be deprecated, so you should start migrating your codebase as soon as possible.<br/>
We have built a [migration guide](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/breaking-changes.html) that will help you move to the new client quickly, and if you have questions or need help, please [open an issue](https://github.com/elastic/elasticsearch-js/issues/new/choose).*
---
The official low-level Elasticsearch client for Node.js and the browser.
[![Coverage Status](http://img.shields.io/coveralls/elastic/elasticsearch-js/master.svg?style=flat-square)](https://coveralls.io/r/elastic/elasticsearch-js?branch=master)
@ -8,7 +16,7 @@ The official low-level Elasticsearch client for Node.js and the browser.
## Features
- One-to-one mapping with REST API and the other official clients
- Generalized, pluggable architecture. See [Extending Core Components](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/extending_core_components.html)
- Generalized, pluggable architecture. See [Extending Core Components](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/extending_core_components.html)
- Configurable, automatic discovery of cluster nodes
- Persistent, Keep-Alive connections
- Load balancing (with pluggable selection strategy) across all available nodes.
@ -23,16 +31,16 @@ npm install elasticsearch
## Use in the Browser
Check out the [Browser Builds](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/browser-builds.html) doc page for help downloading and setting up the client for use in the browser.
Check out the [Browser Builds](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/browser-builds.html) doc page for help downloading and setting up the client for use in the browser.
## Docs
- [Quick Start](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/quick-start.html)
- [Browser Builds](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/browser-builds.html)
- [API](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html)
- [Configuration](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/configuration.html)
- [Development/Contributing](https://github.com/elastic/elasticsearch-js/blob/master/CONTRIBUTING.md)
- [Extending Core Components](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/extending_core_components.html)
- [Logging](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/logging.html)
- [Quick Start](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/quick-start.html)
- [Browser Builds](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/browser-builds.html)
- [API](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/api-reference.html)
- [Configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html)
- [Development/Contributing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/contributing.html)
- [Extending Core Components](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/extending_core_components.html)
- [Logging](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/logging.html)
## Questions?
@ -41,7 +49,7 @@ You can probably find help in [#kibana](https://kiwiirc.com/client/irc.freenode.
## Supported Elasticsearch Versions
Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.12 and greater. We also test against the latest changes in several branches in the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the `apiVersion` config param. [More info](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/configuration.html#config-options)
Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.12 and greater. We also test against the latest changes in several branches in the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the `apiVersion` config param. [More info](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html#config-options)
## Examples
@ -99,7 +107,7 @@ for (const tweet of response.hits.hits) {
}
```
More examples and detailed information about each method are available [here](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html)
More examples and detailed information about each method are available [here](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/index.html)
## License

View File

@ -6,7 +6,7 @@
"name": "elasticsearch",
"description": "The official low-level Elasticsearch client for Node.js and the browser.",
"main": "src/elasticsearch.js",
"homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html",
"homepage": "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/index.html",
"version": "16.1.0",
"keywords": [
"elasticsearch",
@ -112,7 +112,7 @@
},
"repository": {
"type": "git",
"url": "http://github.com/elastic/elasticsearch-js.git"
"url": "https://github.com/elastic/elasticsearch-js-legacy.git"
},
"engines": {
"node": ">=0.8"