Updated the README to match the about doc and include bower install directions. Fixed a bug in the grunt tasks.
This commit is contained in:
12
README.md
12
README.md
@ -14,7 +14,7 @@ The official low-level Elasticsearch client for Node.js and the browser.
|
|||||||
- Persistent, Keep-Alive connections
|
- Persistent, Keep-Alive connections
|
||||||
- Load balancing (with pluggable selection strategy) across all available nodes.
|
- Load balancing (with pluggable selection strategy) across all available nodes.
|
||||||
|
|
||||||
## Install
|
## Install in Node.js
|
||||||
|
|
||||||
```
|
```
|
||||||
npm install elasticsearch
|
npm install elasticsearch
|
||||||
@ -27,7 +27,15 @@ npm install elasticsearch
|
|||||||
|
|
||||||
<!-- [](https://saucelabs.com/u/elasticsearch-js) -->
|
<!-- [](https://saucelabs.com/u/elasticsearch-js) -->
|
||||||
|
|
||||||
We also provide builds of the elasticsearch.js client for use in the browser. Each of the archives listed below contain a generic version of Elasticsearch.js, as well as versions for users of jQuery and Angular.js.
|
We also provide builds of the elasticsearch.js client for use in the browser. These versions of the client are currently ***experimental***. We test these builds using [saucelabs](https://saucelabs.com/u/elasticsearch-js) in Chrome, Firefox, and Internet Explorer 10, and 11. We also test in IE 9, but there is a known issue with making non-standard (get/post) requests across domains.
|
||||||
|
|
||||||
|
### Bower
|
||||||
|
If you use bower to manage your dependencies, then just run:
|
||||||
|
```
|
||||||
|
bower install elasticsearch
|
||||||
|
```
|
||||||
|
|
||||||
|
### Download
|
||||||
|
|
||||||
- v1.4.0: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.tar.gz)
|
- v1.4.0: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.tar.gz)
|
||||||
- master: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.tar.gz)
|
- master: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.tar.gz)
|
||||||
|
|||||||
@ -18,16 +18,20 @@ npm install --save elasticsearch
|
|||||||
|
|
||||||
=== Browser Builds
|
=== Browser Builds
|
||||||
|
|
||||||
To download a build of elasticsearch.js which functions well within modern browsers, use the links
|
We also provide builds of the elasticsearch.js client for use in the browser. These versions of the client are currently ***experimental***. We test these builds using https://saucelabs.com/u/elasticsearch-js[saucelabs] in Chrome, Firefox, and Internet Explorer 10, and 11. We also test in IE 9, but there is a known issue with making non-standard (get/post) requests across domains.
|
||||||
below. These versions of the client are currently ***experimental***. They will break from time to time
|
|
||||||
and should probably not be used on public-facing websites (it's a whopping 150kb of code).
|
|
||||||
|
|
||||||
* v1.4.0 [https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.zip[zip]] [https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.tar.gz[tarball]]
|
==== Bower
|
||||||
* master [https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.zip[zip]] [https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.tar.gz[tarball]]
|
If you use bower to manage your dependencies, then just run:
|
||||||
|
|
||||||
WARNING: The entire API is compatible with IE 10+, Chrome, Firefox, Safari, and Opera. The majority of the API will
|
[source,shell]
|
||||||
also work in IE 8 & 9, but those browsers limit cross domain requests to just GET and POST. IE versions
|
---------
|
||||||
before 8 do not support cross-domain requests nativly.
|
bower install elasticsearch
|
||||||
|
---------
|
||||||
|
|
||||||
|
==== Download
|
||||||
|
|
||||||
|
* v1.4.0: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.4.0.tar.gz[tar.gz]
|
||||||
|
* master: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-master.tar.gz[tar.gz]
|
||||||
|
|
||||||
==== Angular Build (elasticsearch.angular.js)
|
==== Angular Build (elasticsearch.angular.js)
|
||||||
* Registers the elasticsearch object as a factory `esFactory`
|
* Registers the elasticsearch object as a factory `esFactory`
|
||||||
|
|||||||
@ -35,7 +35,7 @@ module.exports = function (grunt) {
|
|||||||
]);
|
]);
|
||||||
|
|
||||||
grunt.registerTask('_upload_archive', function (type) {
|
grunt.registerTask('_upload_archive', function (type) {
|
||||||
grunt.run([
|
grunt.task.run([
|
||||||
'browser_clients:build',
|
'browser_clients:build',
|
||||||
'copy:dist_to_named_dir',
|
'copy:dist_to_named_dir',
|
||||||
'compress:' + type + '_zip',
|
'compress:' + type + '_zip',
|
||||||
|
|||||||
Submodule src/bower-elasticsearch-js updated: 55b727d727...9807183ef4
Reference in New Issue
Block a user