README.md in springboard-0.18.7.1 vs README.md in springboard-0.19.0
- old
+ new
@@ -26,28 +26,31 @@
Springboard uses elasticsearch version numbers so you can require
specific elasticsearch versions in your Gemfile. Create an issue or pull
request if you need a version of the gem with a particular elasticsearch
version.
+Subsequent Springboard releases for the same version will add a
+version specifier to the end of the version, eg 0.18.7.1.
+
## Usage
This gem packages up the elasticsearch binary distribution with a ruby
gem binary on top. It add a config path parameter to the elasticsearch
binary. This makes it easier to put a relative config path on the
command line:
- elasticsearch -c config/elasticsearch -f
+ springboard -c config/elasticsearch -f
All other parameters are passed through to the normal elasticsearch
start script.
Note that you almost always want to specify -c. Without it the default
elasticsearch configs are used and your data/logs will go into the gem
path, almost certainly not what you want.
You can run elasticsearch from a Procfile:
- es: bundle exec elasticsearch -c config/elasticsearch -f
+ es: bundle exec springboard -c config/elasticsearch -f
A rails generator for elasticsearch config files is included. Run:
rails g springboard:config