Permalink
Browse files

started improving doc

  • Loading branch information...
1 parent 738fd7e commit be1f92e5e7c46a49ce994991b2f22d50213aae8c Dominique Rose-Rosette committed Sep 19, 2012
Showing with 45 additions and 14 deletions.
  1. +1 −0 .yardopts
  2. +7 −0 Guardfile
  3. +23 −14 README.md
  4. +2 −0 Rakefile
  5. +3 −0 desi.gemspec
  6. +9 −0 tasks/yard.rake
View
@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - README.md LICENSE
View
@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+guard 'yard' do
+ watch(%r{app/.+\.rb})
+ watch(%r{lib/.+\.rb})
+ watch(%r{ext/.+\.c})
+end
View
@@ -5,28 +5,17 @@ an [Elastic Search](http://www.elasticsearch.org/) local install for
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.
-## Installation
-
-Add this line to your application's Gemfile:
-
- gem 'desi'
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install desi
## Usage
- $ desi list # List locally installed ElasticSearch versions
+ $ 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)
@@ -39,6 +28,26 @@ Or install it yourself as:
$ desi indices "bar$" --empty # Remove all records from the matching
# indices
+## Examples
+
+ * Currently installed releases
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+ gem 'desi'
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install desi
+
## TODO
* add tests, dammit!
View
@@ -1,2 +1,4 @@
#!/usr/bin/env rake
require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each { |task| import task }
View
@@ -15,6 +15,9 @@ an Elastic Search local install for development purposes.}
gem.add_dependency "cocaine"
gem.add_dependency "addressable"
+ gem.add_development_dependency "guard-yard"
+ gem.add_development_dependency "redcarpet"
+
gem.files = `git ls-files`.split($\)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
View
@@ -0,0 +1,9 @@
+begin
+ require 'yard'
+
+ YARD::Rake::YardocTask.new
+rescue LoadError
+ task :yard do
+ abort 'YARD is not available. In order to run yard, you must: gem install yard'
+ end
+end

0 comments on commit be1f92e

Please sign in to comment.