README.md in openshifter-0.1 vs README.md in openshifter-0.2
- old
+ new
@@ -1,8 +1,8 @@
## OpenShifter
-Simple CLI tool to siplify the deployment of Sinatra applications using JRuby to OpenShift
+Simple CLI tool to siplify the deployment of Rack-based applications using JRuby to OpenShift
## How to
### Step 1
@@ -18,30 +18,80 @@
Now you setup your environment
openshifter-setup
-The tools downloads JRuby and JRuby-Rack to create runtime environment. Then Bundler is instaled locally for the application. The whole environment is vendored for you application.
+This step replaces .openshift folder contaning meta-data for your application.
### Step 4
+Now you may modify configuration of your deployment. It is stored in .openshift/openshifter. It is ordinary YAML file. Possible options are
+
+ jruby: 1.6.6 # JRuby version you want to use
+ jrack: 1.1.3 # JRuby-Rack version used
+ install: vendor # Instalation method vendor/remote
+
+Vendor instalation method installs all libraries and gems in .openshift folder and are versioned with your application. Remote installation installed all libraries and gems on server in the time of deployment.
+
+If you decide to use remote installation method. You are done. For vendor installation method, please continue.
+
+### Step 5
+
+Downloads JRuby and JRuby-Rack to create runtime environment. Then Bundler is instaled locally for the application.
+
+ openshifter-download
+
+### Step 4
+
At the setup time and whenever you add gems to your Gemfile, just run
openshifter-bundle
-to vendor your gems locally.
+gems will be venoder in .openshift folder and you have to add them to VCS.
### Step 5
Add, commit and push to openshift.
+## Upgrading
+
+### OpenShifter
+
+For remote install just run
+
+ openshifter-setup --upgrade
+
+for vendored install it's more complicated
+
+ openshifter-setup --upgrade
+ openshifter-download
+ openshifter-bundle
+
+**will be simplified in the future version**
+
+### JRuby
+
+For remote install, just modify .openshift/openshifter configuration.
+
+For vendor install modify .openshift/openshifter configuration and then run.
+
+ openshifter-download
+
## Interface
Setup the environment
openshifter-setup
+To upgrade openshifter
+
+ openshifter-setup --upgrade
+
+Download JRuby and environment libraries
+
+ openshifter-download
+
Bundler wrapper
openshifter-bundle
Gem wrapper
@@ -68,6 +118,6 @@
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
-limitations under the License.
\ No newline at end of file
+limitations under the License.