Made documentation more current after restructuring

Author: ysb33r

README.md

@@ -12,51 +12,38 @@ The Ruby gem dependency code for this project relies on the [Rubygems Maven
 proxy](http://rubygems-proxy.torquebox.org/) provided by the
 [Torquebox](http://torquebox.org) project.
 
-## Compatilibity
-
-This plugin requires Gradle 2.0 or better
-
-JRuby 1.7.14 seem to have some bugs. Although this plugin has a workaround it is recommended that you avoid using 1.7.14
-with the jruby-gradle-plugin.
-
-## Getting Started
+This is the base plugin. If you are interesting in doing the following then consult the pages for the appropriate
+plugins:
 
-### Setting up Gradle
-
-**Note:** This assumes you already have [Gradle](http://gradle.org) installed.
-
-```bash
-% mkdir fancy-webapp
-% cd fancy-webapp
-% git init
-Initialized empty Git repository in /usr/home/tyler/source/github/fancy-webapp/.git/
-% gradle wrapper  # Create the wrappers to easily bootstrap others
-wrapper
+* Building JRuby-based Java JARs, including making them executable - 
+[jruby-gradle-jar-plugin](http://github.come/jruby-gradle/jruby-gradle-jar-plugin)
+* Building JRuby-based Java Web Applications (WARs),  - 
+[jruby-gradle-war-plugin](http://github.come/jruby-gradle/jruby-gradle-war-plugin)
 
-BUILD SUCCESSFUL
 
-Total time: 6.411 secs
-% git add gradle gradlew gradlew.bat
-% git commit -m "Initial commit with gradle wrappers"
-```
+## Compatilibity
 
-### Creating a gradle configuration file
+This plugin requires Gradle 2.0 or better
 
-Create a `build.gradle` file in the root of `fancy-webapp/` with the following:
+`JRuby 1.7.14` seem to have some bugs. Although this plugin has a workaround for this version it is recommended that you 
+avoid using `1.7.14` with the `jruby-gradle-plugin`.
 
+## Getting Started
 
 ```groovy
-apply plugin: 'com.lookout.jruby'
-
 buildscript {
     repositories { jcenter() }
 
     dependencies {
-      classpath group: 'com.lookout', name: 'jruby-gradle-plugin', version: '2.1.+'
+      classpath group: 'com.github.jrubygradle', name: 'jruby-gradle-plugin', version: '0.1.2'
     }
 }
+
+apply plugin: 'com.github.jrubygradle.base'
 ```
 
+### Adding gems
+
 You can also add Ruby gem dependencies in your `build.gradle` file under the
 `gem` configuration, e.g.:
 
@@ -67,141 +54,14 @@ dependencies {
 }
 ```
 
-In order to include Java-based dependencies in a `.war` file, declare those
-dependencies under the `jrubyWar` configuration, e.g.:
-
-```groovy
-dependencies {
-    jrubyWar group: 'org.apache.kafka', name: 'kafka_2.9.2', version: '0.8.+'
-    jrubyWar group: 'log4j', name: 'log4j', version: '1.2.+', transitive: true
-}
-```
-
-Dependencies declared under the `jrubyWar` configuration will be copied into
-`.jarcache/` and `.war/WEB-INF/libs` when the archive is created.
-
-
 ## Default Tasks
 
 The plugin provides the following tasks:
 
- * `jrubyWar` - Creates a runnable web archive file in `build/libs` for your
-   project.
  * `jrubyPrepareGems` - Extract GEMs declared as dependencies under `gems` to `jruby.gemInstallDir`. This is as instance
  of `JRubyPrepareGems`.
  * `jrubyPrepare` - Call `jrubyPrepareGems`. Also copies the
    content of Java-based dependencies into `.jarcache/` for interpreted use
-   (see below)
- * `jrubyClean` - Cleans up the temporary directories that tasks like
-   `jrubyWar`- Creates a `war` file
-
-## Creating a .war
-
-Currently the Gradle tooling expects the web application to reside in
-`src/main/webapp/WEB-INF`, so make sure your `config.ru` and application code
-are under that root directory. It may be useful to symbolicly link this to
-`app/` in your root project directory. An *full* example of this can be found in the
-[ruby-gradle-example](https://github.com/rtyler/ruby-gradle-example)
-repository.
-
-Once your application is ready, you can create the `.war` by executing the `jrubyWar` task:
-
-```bash
-% ./gradlew jrubyWar  
-:compileJava UP-TO-DATE
-:processResources UP-TO-DATE
-:classes UP-TO-DATE
-:jrubyCacheJars
-:jrubyCacheGems
-:jrubyPrepareGems
-/home/tyler/.rvm/rubies/ruby-1.9.3-p484/lib/ruby/1.9.1/yaml.rb:84:in `<top (required)>':
-It seems your ruby installation is missing psych (for YAML output).
-To eliminate this warning, please install libyaml and reinstall your ruby.
-Successfully installed rack-1.5.2
-Successfully installed rack-protection-1.5.3
-2 gems installed
-/home/tyler/.rvm/rubies/ruby-1.9.3-p484/lib/ruby/1.9.1/yaml.rb:84:in `<top (required)>':
-It seems your ruby installation is missing psych (for YAML output).
-To eliminate this warning, please install libyaml and reinstall your ruby.
-Successfully installed rake-10.3.2
-1 gem installed
-/home/tyler/.rvm/rubies/ruby-1.9.3-p484/lib/ruby/1.9.1/yaml.rb:84:in `<top (required)>':
-It seems your ruby installation is missing psych (for YAML output).
-To eliminate this warning, please install libyaml and reinstall your ruby.
-Successfully installed tilt-1.4.1
-1 gem installed
-/home/tyler/.rvm/rubies/ruby-1.9.3-p484/lib/ruby/1.9.1/yaml.rb:84:in `<top (required)>':
-It seems your ruby installation is missing psych (for YAML output).
-To eliminate this warning, please install libyaml and reinstall your ruby.
-Successfully installed sinatra-1.4.5
-1 gem installed
-:jrubyPrepare
-:jrubyWar
-
-BUILD SUCCESSFUL
-
-Total time: 1 mins 34.84 secs
-%
-```
-
-Once the `.war` has been created you can find it in `build/libs` and deploy that into a servlet container such as Tomcat or Jetty.
-
-
-## Using the Ruby interpreter
-
-There are still plenty of cases, such as for local development, when you might
-not want to create a full `.war` file to run some tests. In order to use the
-same gems and `.jar` based dependencies, add the following to the entry point
-for your application:
-
-```ruby
-# Hack our GEM_HOME to make sure that the `rubygems` support can find our
-# unpacked gems in ./vendor/
-vendored_gems = File.expand_path(File.dirname(__FILE__) + '/vendor')
-if File.exists?(vendored_gems)
-  ENV['GEM_HOME'] = vendored_gems
-end
-
-jar_cache = File.expand_path(File.dirname(__FILE__) + '/.jarcache/')
-if File.exists?(jar_cache)
-  # Under JRuby `require`ing a `.jar` file will result in it being added to the
-  # classpath for easy importing
-  Dir["#{jar_cache}/*.jar"].each { |j| require j }
-end
-```
-
-**Note:** in the example above, the `.rb` file is assuming it's in the top
-level of the source tree, i.e. where `build.gradle` is located
-
-## Advanced Usage
-
-### Using a custom Gem repository
-
-By default the jruby plugin will use
-[rubygems-proxy.torquebox.org](http://rubygems-proxy.torquebox.org) as its
-source of Ruby gems. This is a server operated by the Torquebox project which
-presents [rubygems.org](https://rubygems.org) as a Maven repository.
-
-If you **do not** wish to use this repository, you can run your own Maven
-proxy repository for either rubygems.org or your own gem repository by
-running the [rubygems-servlets](https://github.com/torquebox/rubygems-servlets)
-server.
-
-You can then use that custom Gem repository with:
-
-```groovy
-jruby {
-    defaultRepositories = false
-}
-
-repositories {
-    maven { url : 'http://localhost:8989/releases' }
-}
-
-dependencies {
-    gems group: 'com.lookout', name: 'custom-gem', version: '1.0.+'
-}
-```
 
 ## JRubyExec - Task for Executing a Ruby Script 
 
@@ -290,8 +150,89 @@ task unpackMyGems( type : JRubyPrepareGems ) {
   outputDir buildDir
   
   // Add one or more gems
-  // Can be String(s), File(s), FleCollection(s) or Configuration(s)
+  // Can be String(s), File(s), FileCollection(s) or Configuration(s)
   gems project.configuration.gems
   
 }
 ```
+
+
+## Advanced Usage
+
+### Using a custom Gem repository
+
+By default the jruby plugin will use
+[rubygems-proxy.torquebox.org](http://rubygems-proxy.torquebox.org) as its
+source of Ruby gems. This is a server operated by the Torquebox project which
+presents [rubygems.org](https://rubygems.org) as a Maven repository.
+
+If you **do not** wish to use this repository, you can run your own Maven
+proxy repository for either rubygems.org or your own gem repository by
+running the [rubygems-servlets](https://github.com/torquebox/rubygems-servlets)
+server.
+
+You can then use that custom Gem repository with:
+
+```groovy
+jruby {
+    defaultRepositories = false
+}
+
+repositories {
+    maven { url : 'http://localhost:8989/releases' }
+}
+
+dependencies {
+    gems group: 'com.lookout', name: 'custom-gem', version: '1.0.+'
+}
+```
+
+## Using the Ruby interpreter
+
+There are still plenty of cases, such as for local development, when you might
+not want to create a full `.war` file to run some tests. In order to use the
+same gems and `.jar` based dependencies, add the following to the entry point
+for your application:
+
+```ruby
+# Hack our GEM_HOME to make sure that the `rubygems` support can find our
+# unpacked gems in build/vendor/
+vendored_gems = File.expand_path(File.dirname(__FILE__) + '/build/vendor')
+if File.exists?(vendored_gems)
+  ENV['GEM_HOME'] = vendored_gems
+end
+
+jar_cache = File.expand_path(File.dirname(__FILE__) + '/.jarcache/')
+if File.exists?(jar_cache)
+  # Under JRuby `require`ing a `.jar` file will result in it being added to the
+  # classpath for easy importing
+  Dir["#{jar_cache}/*.jar"].each { |j| require j }
+end
+```
+
+**Note:** in the example above, the `.rb` file is assuming it's in the top
+level of the source tree, i.e. where `build.gradle` is located
+
+
+## Quickstart for those unfamiliar with Gradle
+
+**Note:** This assumes you already have [Gradle](http://gradle.org) installed. If you are not on Windows it is recommended
+that you use [GVM](http://gvmtool.net) to install Gradle
+
+```bash
+% mkdir fancy-webapp
+% cd fancy-webapp
+% git init
+Initialized empty Git repository in /usr/home/tyler/source/github/fancy-webapp/.git/
+% gradle wrapper init  # Create the wrappers to easily bootstrap others
+:wrapper
+:init 
+
+BUILD SUCCESSFUL
+
+Total time: 6.411 secs
+% git add gradle gradlew gradlew.bat
+% git commit -m "Initial commit with gradle wrappers"
+```
+
+Edit the created `build.gradle` file in the root of `fancy-webapp/` as above