README.md in desi-0.2.0 vs README.md in desi-0.2.1
- old
+ new
@@ -1,6 +1,8 @@
-# Desi
+Desi
+====
+[](http://travis-ci.org/AF83/desi)
Desi (Developper ElasticSearch Installer) is very simple tool to quickly set up
an [Elastic Search](http://www.elasticsearch.org/) local install for
development purposes.
@@ -49,11 +51,29 @@
```ruby
Desi::LocalInstall.new.releases.map(&:name) #=> ["elasticsearch-0.19.8", "elasticsearch-0.19.9"]
Desi::LocalInstall.new.releases.detect(&:current?).version #=> "0.19.9"
```
+### Start a node instance and get the cluster's status
+ * command-line
+
+ ```shell
+ $ desi start
+ * Elastic Search 0.19.9 started
+ $ desi status
+ OK. Elastic Search cluster 'elasticsearch' (v0.19.9) is running on 1 node(s) with status yellow
+ ```
+
+
+ * library
+
+ ```ruby
+ Desi::ProcessManager.new.start.status #=> "OK. Elastic Search cluster 'elasticsearch' (v0.19.9) is running on 1 node(s) with status green"
+ ```
+
+
### List and delete some indices
* command-line
```shell
@@ -63,11 +83,11 @@
foo
bar
baz
- $ # List all indices on remote cluster 129.168.1.42, reachable on port 9800
+ $ # List all indices with "foo" in their name on remote cluster 129.168.1.42, port 9800
$ desi indices --host 129.168.1.42:9800 foo
Indices from host http://192.168.1.42:9800 matching the pattern /foo/
remotefoo1
remotefoo2
@@ -84,19 +104,19 @@
```ruby
# All local indices
Desi::IndexManager.new.list #=> ["foo", "bar", "baz"]
- # All local indices whose name starts with `b`
+ # All local indices whose name starts with "b"
Desi::IndexManager.new.list("^b") #=> ["bar", "baz"]
# All indices from distant cluster
Desi::IndexManager.new(host: "192.168.1.42:9800").list #=> ["remotefoo1", "remotefoo2"]
- # Delete all local indices whose name starts with `ba`
+ # Delete all local indices whose name starts with "ba"
Desi::IndexManager.new.delete!("^ba") #=> nil
- # The indices actually disappeared
+ # The indices actually disappeared! \o/
Desi::IndexManager.new.list #=> ["foo"]
```