Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Readme info.

Signed-off-by: Nick Campbell <nicholas.j.campbell@gmail.com>
  • Loading branch information...
commit eae5ae7bedc2a0328a606c565a2c1f4e9395e5a7 1 parent 631494d
@ncb000gt authored
Showing with 41 additions and 0 deletions.
  1. +41 −0 README.md
View
41 README.md
@@ -0,0 +1,41 @@
+node-elasticsearch
+============
+
+This is a module around the REST API for [http://www.elasticsearch.org/](Elastic Search) built for NodeJS.
+
+
+Details
+=============
+
+This works with node 0.4.x and with 0.2.x. I needed it for both and so wrote an http compatability layer.
+
+
+Usage
+=============
+
+ var lib = require('elasticsearch'), sys = require('sys'); //replace sys with util if you're on node 0.4.x
+ lib.createClient(function(client) {
+ client.query({query: {field: {field1: 'hai'}}}, function(err, results) {
+ console.log(sys.inspect(results, true, 10));
+ });
+ });
+
+
+API
+==============
+
+*Will go here when I'm ready to post it.*
+
+
+Requirements
+=============
+
+* NodeJS
+* Elastic Search
+* The need for search
+
+
+License
+=============
+
+MIT
Please sign in to comment.
Something went wrong with that request. Please try again.