README.md in desi-0.0.2 vs README.md in desi-0.1.0
- old
+ new
@@ -1,12 +1,60 @@
# 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. It will download and install ElasticSearch (the latest
-version by default) and let you start/stop/restart it.
+development purposes.
+It can:
+
+ * download and install ElasticSearch (the latest release by default)
+ * start/stop/restart it.
+ * do basic indices management (list, delete, empty a given set of indices)
+
+It can be used both as a command-line tool and as a library.
+
+
+## Usage
+
+ $ desi list # List locally installed ElasticSearch releases
+ $ desi releases # List all upstream Elastic Search releases (latest 5 by default)
+ $ desi install [VERSION] # Install a specific version (latest by default)
+ $ desi start # Start a local 1-node cluster (noop if active)
+ $ desi restart # (Re)start cluster (even if active)
+ $ desi stop # Stop cluster
+ $ desi status [--host HOST] # Show running cluster info
+
+ $ desi indices "^foo" # List all indices whose name match /^foo/
+ $ desi indices "^foo" --delete # Delete all matching indices
+ $ desi indices "bar$" --empty # Remove all records from the matching
+ # indices
+
+## Examples
+
+### Currently installed releases
+
+The current version is the one symlinked to `$HOME/elasticsearch/current`
+
+ * command-line
+
+ ```shell
+ $ desi list
+ Local ES installs (current one is tagged with '*'):
+ * elasticsearch-0.19.9 (/home/me/elasticsearch/elasticsearch-0.19.9)
+ - elasticsearch-0.19.8 (/home/me/elasticsearch/elasticsearch-0.19.8)
+ ```
+
+
+ * library
+
+ ```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"
+ ```
+
+
+
## Installation
Add this line to your application's Gemfile:
gem 'desi'
@@ -17,24 +65,13 @@
Or install it yourself as:
$ gem install desi
-## Usage
-
- $ desi list # List locally installed ElasticSearch versions
- $ desi releases # List all upstream Elastic Search releases (latest 5 by default)
- $ desi install [VERSION] # Install a specific version (latest by default)
- $ desi start # Start a local 1-node cluster (noop if active)
- $ desi restart # (Re)start cluster (even if active)
- $ desi stop # Stop cluster
- $ desi status # Show running cluster info
-
## TODO
* add tests, dammit!
- * index management (list, create, delete ES indices)
* `desi upgrade` (Upgrade to latest version and migrate data)
* `desi switch VERSION` (Switch currently active ES version to VERSION)
* plugin management ? (list, install, remove ES plugins)
## Contributing