diff --git a/docs/about.asciidoc b/docs/about.asciidoc index a61dab1da..01bbe7bf1 100644 --- a/docs/about.asciidoc +++ b/docs/about.asciidoc @@ -17,46 +17,4 @@ npm install --save elasticsearch -------- === Browser Builds - -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. - -==== Bower -If you use bower to manage your dependencies, then just run: - -[source,shell] ---------- -bower install elasticsearch ---------- - -==== Download - * v2.1.4: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-2.1.4.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-2.1.4.tar.gz[tar.gz] - - -==== Angular Build (elasticsearch.angular.js) - * Registers the elasticsearch object as a factory `esFactory` - * Uses Angular's `$http` service - * Returns promises using Angular's `$q` service to properly trigger digest cycles within Angular - -.Create a client instance and register it as a service -[source,js] -------------------- -module.service('es', function (esFactory) { - return esFactory({ - host: 'localhost:9200', - // ... - }); -}); -------------------- - -==== jQuery Build (elasticsearch.jquery.js) - * Uses jQuery's `.ajax()` functionality - * Returns jQuery "promises" - * Registers the module at `jQuery.es` - -.Create a client with the jQuery build -[source,js] -------------------- -var client = new $.es.Client({ - hosts: 'localhost:9200' -}); -------------------- +See <> \ No newline at end of file diff --git a/docs/browser_builds.asciidoc b/docs/browser_builds.asciidoc new file mode 100644 index 000000000..2ccccae54 --- /dev/null +++ b/docs/browser_builds.asciidoc @@ -0,0 +1,47 @@ +[browser-builds] +==== Browser Builds + +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. + +While there is https://github.com/elasticsearch/elasticsearch-js/issues/96#issuecomment-42617480[a way to get it working in IE 9], the browser severly limits what you can do with cross-domain requests. Because of these limits, many of the API calls and other functionality do not work. + +===== Bower +If you use bower to manage your dependencies, then just run: + +[source,shell] +--------- +bower install elasticsearch +--------- + +===== Download + * v2.1.4: https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-2.1.4.zip[zip], https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-2.1.4.tar.gz[tar.gz] + + +===== Angular Build (elasticsearch.angular.js) + * Registers the elasticsearch object as a factory `esFactory` + * Uses Angular's `$http` service + * Returns promises using Angular's `$q` service to properly trigger digest cycles within Angular + +.Create a client instance and register it as a service +[source,js] +------------------- +module.service('es', function (esFactory) { + return esFactory({ + host: 'localhost:9200', + // ... + }); +}); +------------------- + +===== jQuery Build (elasticsearch.jquery.js) + * Uses jQuery's `.ajax()` functionality + * Returns jQuery "promises" + * Registers the module at `jQuery.es` + +.Create a client with the jQuery build +[source,js] +------------------- +var client = new $.es.Client({ + hosts: 'localhost:9200' +}); +------------------- diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 51b51933c..5bf76109f 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -2,6 +2,8 @@ include::about.asciidoc[] +include::browser_builds.asciidoc[] + include::quick_start.asciidoc[] include::api_conventions.asciidoc[]