updated some links in the readme, and removed the bower stuff for now.

This commit is contained in:
Spencer Alger
2013-12-12 16:53:33 -07:00
parent c5440792d3
commit de25e652cf

View File

@ -1,71 +1,35 @@
# elasticsearch.js
Official *low-level* client for Elasticsearch.
The official low-level Elasticsearch client for Node.js and the browser.
## Features
- One-to-one mapping with REST API and other language clients
- Generalized, pluggable architecture. See [replacing core components](docs/replacing_core_components.md)
- One-to-one mapping with REST API and the other official clients
- Generalized, pluggable architecture. See [Extending Core Components](http://spenceralger.github.io/elasticsearch-js/index.html#extending)
- Configurable, automatic discovery of cluster nodes
- Persistent, Keep-Alive connections
- Load balancing (with pluggable selection strategy) across all available nodes.
## Node and the browser
elasticsearch.js works great in node, as well as modern browsers (many thanks to [browserify](https://github.com/substack/node-browserify)!!).
- Node:
[![Build Status](https://spenceralger.com/jenkins-badge/es/es-js_nightly)](http://build.elasticsearch.com/job/es-js_nightly)
- Browsers (see [browser builds](#browser-builds)):
[![current browser support](https://spenceralger.com/jenkins-browser-badge/es_js)](http://build.elasticsearch.com/job/es-js_nightly)
## Install in Node
## Install
```
npm install --save elasticsearch
npm install elasticsearch
```
## Browser Builds
Download one of these browser-ready builds, or install them with `bower`
We also provide builds of the elasticsearch.js client for use in the browser. If your project uses Angular or jQuery we also provide specifc builds for you, simply include the `elasticsearch.{{lib}}.js` files in your project instead.
NOTE: The entire API is compatible with IE 10+, Chrome, Firefox, Safari, and Opera. **IE 8 & 9** only support GET and POST requests cross-domain which is how the `XhrConnection` class makes it's requests.
- [elasticsearch.js](dist/elasticsearch.min.js) - [dev](dist/elasticsearch.js)
- uses the browser's native XMLHttpRequest object
- Node style callbacks or promises provided by [when.js](https://github.com/cujojs/when)
```
bower install elasticsearch
```
- [elasticsearch.angular.js](dist/elasticsearch.angular.min.js) - [dev](dist/elasticsearch.angular.js)
- Uses Angular's $http service
- Returns promises using Angular's $q service (Adds an `abort()` method)
```
bower install elasticsearch-angular
```
- [elasticsearch.jquery.js](dist/elasticsearch.jquery.min.js) - [dev](dist/elasticsearch.jquery.js)
- Uses jQuery's .ajax() method
- Returns jQuery promises (Adds an `abort()` method)
```
bower install elasticsearch-jquery
```
- v0.0.1: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/0.0.1/elasticsearch-js.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/0.0.1/elasticsearch-js.tar.gz)
- master: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/master/elasticsearch-js.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/master/elasticsearch-js.tar.gz)
## Docs
- [Quick Start](http://spenceralger.github.io/elasticsearch-js/index.html#quick-start)
- [API](http://spenceralger.github.io/elasticsearch-js/api.html)
- [Configuration](http://spenceralger.github.io/elasticsearch-js/index.html#configuration)
- [Development/Contributions](http://spenceralger.github.io/elasticsearch-js/index.html#dev)
- [Extending Core Components](http://spenceralger.github.io/elasticsearch-js/index.html#extending)
- [Logging](http://spenceralger.github.io/elasticsearch-js/index.html#logging)
- [Contributing](http://spenceralger.github.io/elasticsearch-js/index.html#contributing)
## License