habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Browser Builds docs (#528)

Browse Source 
* Document how to properly install using npm

* The standard elasticsearch-js build does not works in browser anymore

* The React sample can be confusing nowadays.

Since it refers to an older version that used to work in the browser, now that there
is a browser specific build, the sample is somewhat confusing.

* Closes https://github.com/elastic/elasticsearch-js/issues/527

Since it refers to an older version that used to work in the browser, now that there
is a browser specific build, the sample is somewhat confusing.

* Fix typo
This commit is contained in:
Thiago Souza
2017-04-24 14:30:33 -03:00
committed by spalger
parent 013da44d79
commit d241f2d6ef
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/browser_builds.asciidoc
View File

@ -13,11 +13,17 @@ If you use bower to manage your dependencies, then just run:
bower install elasticsearch
---------
=== NPM
If you use npm to manage your dependencies, then just run:
[source,shell]
---------
npm install elasticsearch-browser
---------
=== Download
* v13.0.0-rc2: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-13.0.0-rc2.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-13.0.0-rc2.tar.gz[tar.gz]
NOTE: Here's an example that integrates elasticsearch.js with React https://github.com/scotchfield/elasticsearch-react-example/[on GitHub]
=== Angular Build
* Registers an `esFactory` factory in the `"elasticsearch"` module
* Uses Angular's `$http` service