From f18a13454f710d190387dd99a8098e39ba0551b8 Mon Sep 17 00:00:00 2001 From: Spencer Alger Date: Fri, 17 Jan 2014 18:59:03 -0700 Subject: [PATCH] version 1.2 --- CHANGELOG.md | 9 ++++++--- README.md | 19 ++++++++++++++++--- package.json | 2 +- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3275e0afb..5893e9c81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,18 @@ # elasticsearch-js changelog -## 1.1 (Dec 22 2013) +## 1.2 (Jan 17 2014) +- `apiVersion` config parameter was added. Use this to specify which API the client should provide, we currently offer support for elasticsearch branches "0.90", "1.0", and "master" + +## 1.1 (Dec 22 2013) - Changed the resolution value of promises. Instead of being an object like `{body: ..., status: ...}` it is now just the response body. -## 1.0 (Dec 17 2013) +## 1.0 (Dec 17 2013) - Initial Release -## pre 1.0 +## pre 1.0 - Another module, now know as es on npm, used the elasticsearch module name. This module had several pre-1.0 releases so we started at 1.0 to prevent collisions in exiting projects. The history for that project is available [here](https://github.com/ncb000gt/node-es) \ No newline at end of file diff --git a/README.md b/README.md index baaffaeed..b1c7a2e73 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ The official low-level Elasticsearch client for Node.js and the browser. [![Build Status](https://www.codeship.io/projects/f0c2b4a0-61c9-0131-3fd3-367b94dc0d60/status?branch=master)](https://www.codeship.io/projects/12289) -[![Build Status](https://build.elasticsearch.org/job/es-js_nightly/badge/icon)](https://build.elasticsearch.org/job/es-js_nightly/) +
[![Coverage Status](https://coveralls.io/repos/elasticsearch/elasticsearch-js/badge.png)](https://coveralls.io/r/elasticsearch/elasticsearch-js) ## Features @@ -20,8 +20,13 @@ The official low-level Elasticsearch client for Node.js and the browser. npm install elasticsearch ``` + +[![NPM](https://nodei.co/npm/ecstatic.png?downloads=true)](https://npmjs.org/package/elasticsearch) + ## Browser Builds + + 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. - v1.1.0: [zip](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.1.0.zip), [tar.gz](https://download.elasticsearch.org/elasticsearch/elasticsearch-js/elasticsearch-js-1.1.0.tar.gz) @@ -35,6 +40,12 @@ We also provide builds of the elasticsearch.js client for use in the browser. If - [Extending Core Components](http://elasticsearch.github.io/elasticsearch-js/index.html#extending) - [Logging](http://elasticsearch.github.io/elasticsearch-js/index.html#logging) +## Supported Elasticsearch Versions + +[![Build Status](https://build.elasticsearch.org/job/es-js_nightly/badge/icon)](https://build.elasticsearch.org/job/es-js_nightly/) + +Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases **0.90.5 and greater**. We also test against the latest changes in the 0.90 and master branches of the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the `apiVerson` config param. [More info](http://www.elasticsearch.org/guide/en/elasticsearch/client/javascript-api/current/configuration.html#_config_options) + ## Examples Create a client instance @@ -46,10 +57,12 @@ var client = new elasticsearch.Client({ }); ``` -Send a HEAD request to "/?hello=elasticsearch" and allow up to 1 second for it to complete. +Send a HEAD request to `/?hello=elasticsearch` and allow up to 1 second for it to complete. ```js client.ping({ + // ping usually has a 100ms timeout requestTimeout: 1000, + // undocumented params are appended to the query string hello: "elasticsearch!" }, function (error) { @@ -97,7 +110,7 @@ client.search({ This software is licensed under the Apache 2 license, quoted below. - Copyright (c) 2013 Elasticsearch + Copyright (c) 2014 Elasticsearch Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/package.json b/package.json index 5ea377c2f..31d8f525b 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "description": "The official low-level Elasticsearch client for Node.js and the browser.", "main": "src/elasticsearch.js", "homepage": "http://elasticsearch.github.io/elasticsearch-js/", - "version": "1.1.0", + "version": "1.2.0", "browser": { "./src/lib/connectors/index.js": "./src/lib/connectors/browser_index.js", "./src/lib/loggers/index.js": "./src/lib/loggers/browser_index.js",