Skip to content
This repository was archived by the owner on Feb 17, 2022. It is now read-only.

Update README and links #5

Merged
merged 4 commits into from
Jun 4, 2019
Merged

Update README and links #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9bb06c1
Updated README.md
delvedor May 24, 2019
c070cf3
Updated changelog url
delvedor May 24, 2019
35bfca7
Updated homepage and repository fields
delvedor May 24, 2019
ccdfa59
Merge branch '16.x' into update-readme
delvedor Jun 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This URL doesn't contain any information.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, all the info seems to have moved to the sections outlined on the right, I'll see if there's something we can do to get these listed back into a single page.

30 changes: 19 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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.
Expand All @@ -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?
Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -112,9 +112,9 @@
},
"repository": {
"type": "git",
"url": "http://github.com/elastic/elasticsearch-js.git"
"url": "https://github.com/elastic/elasticsearch-js-legacy.git"
},
"engines": {
"node": ">=0.8"
}
}
}