README.md in ood_appkit-0.3.2 vs README.md in ood_appkit-0.3.3

@@ -1,14 +1,34 @@
+# OOD App Kit
+
+The `ood_appkit` gem is a package of utility functions and engines for
+applications running on the Open OnDemand platform.
+
+Functionality includes:
+* [Rake tasks](#rake-tasks)
+* [URL handlers for OOD System applciations](#url-handlers-for-system-apps)
+* [Rack middleware for handling files under a configured dataroot](#rack-middleware-for-handling-files-under-dataroot)
+* [A wiki static page engine](#wiki-static-page-engine)
+* [Override Bootstrap Variables](#override-bootstrap-variables)
+* [A markdown handler](#markdown-handler)
+* [Custom Log Formatting](#custom-log-formatting)
+* [Branding Features](#branding-features)
+* [Information on Configured Clusters](#cluster-information)
+
 ## Installation
 
 To use, add this line to your application's Gemfile:
 
-    gem 'ood_appkit'
+```bash
+gem 'ood_appkit'
+```
 
 And then execute:
 
-    bundle install
+```bash
+bundle install
+```
 
 ## Usage
 
 ### Rake Tasks
 
@@ -327,10 +347,21 @@
 
 // this MUST occur after the bootstrap overrides
 @import "bootstrap";
 ```
 
+**Note:** After changing an environment variable or configuration option in the
+initalizer you must **clobber** your assets and **restart** the app:
+
+```bash
+# clobber assets
+bin/rake assets:clobber
+
+# restart app
+touch tmp/restart.txt
+```
+
 ### Markdown Handler
 
 A simple markdown handler is included with this gem. Any views with the
 extensions `*.md` or `*.markdown` will be handled using the `Redcarpet` gem.
 The renderer can be modified as such:
@@ -357,19 +388,39 @@
 rendered markdown to resemble GitHub's display of markdown.
 
 ```scss
 // app/assets/stylesheets/application.scss
 
+// load the bootstrap sprockets first
+@import "bootstrap-sprockets";
+
+// this MUST occur before you import bootstrap
+@import "ood_appkit/bootstrap-overrides";
+
+// this MUST occur after the bootstrap overrides
+@import "bootstrap";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit/markdown";
 ```
 
 It is also included if you import the default stylesheet:
 
 
 ```scss
 // app/assets/stylesheets/application.scss
 
+// load the bootstrap sprockets first
+@import "bootstrap-sprockets";
+
+// this MUST occur before you import bootstrap
+@import "ood_appkit/bootstrap-overrides";
+
+// this MUST occur after the bootstrap overrides
+@import "bootstrap";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit";
 ```
 
 ### Custom Log Formatting
 
@@ -409,19 +460,39 @@
 To take advantage of branding features you must import it in your stylesheet:
 
 ```scss
 // app/assets/stylesheets/application.scss
 
+// load the bootstrap sprockets first
+@import "bootstrap-sprockets";
+
+// this MUST occur before you import bootstrap
+@import "ood_appkit/bootstrap-overrides";
+
+// this MUST occur after the bootstrap overrides
+@import "bootstrap";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit/branding";
 ```
 
 It is also included if you import the default stylesheet:
 
 
 ```scss
 // app/assets/stylesheets/application.scss
 
+// load the bootstrap sprockets first
+@import "bootstrap-sprockets";
+
+// this MUST occur before you import bootstrap
+@import "ood_appkit/bootstrap-overrides";
+
+// this MUST occur after the bootstrap overrides
+@import "bootstrap";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit";
 ```
 
 ### Navbar Breadcrumbs
 
@@ -596,9 +667,11 @@
 cluster):
 
 ```sh
 OOD_CLUSTERS="/path/to/configs.d"
 ```
+
+The default location is: `/etc/ood/config/clusters.d`
 
 ## Develop
 
 Generated using: