README.md in jarbler-0.1.3 vs README.md in jarbler-0.1.4
- old
+ new
@@ -1,13 +1,12 @@
# Jarbler
Pack a Ruby application into an executable jar file.
-Jarbler allows you to create an self executing Java jar file containing your Ruby application.
+Jarbler creates a self executing Java jar file containing a Ruby application and all its Gem dependencies.
This tool is inspired by the widely used jRuby runner Warbler.
-In contrast to Warbler no Java servlet container is needed for execution.
-Instead the configured executable is executed using the jRuby runtime jars.
+The configured Ruby program is directly executed inside the JVM using the jRuby runtime jars.
## Installation
Install the gem and add to the application's Gemfile by executing:
@@ -26,10 +25,11 @@
To adjust Jarbler's configuration, modify the settings in config file ´config/jarble.rb´. The template for this config file you create by executing
$ jarble config
### Preconditions
+* Dependency handling should be based on Bundler (existence of Gemfile is required)
* The Ruby app should be capable of running with jRuby
* Gems with native extensions should not be used (e.g. sassc)
* if needed for development or test such Gems with native extensions should be moved to the development and test group in the Gemfile.
* Otherwise the created jar file may not be executable on all platforms and Java versions.
@@ -41,10 +41,10 @@
Additional command line parameters are passed through to the executed Ruby app (like "-p 8900" for different network port number with bin/rails)
## Configuration
The file config/jarble.rb contains the configuration for Jarbler.
-To create a template config file with information about the supported configuration options, execute:
+To create a template config file with information about all the supported configuration options, execute:
$ jarble config
The default configuration supports Ruby on Rails applications.<br>
The executable is set to "bin/rails" by default.<br>