README.md in csp_report-0.2.0 vs README.md in csp_report-0.3.0

@@ -2,31 +2,30 @@
 =========
 
 This gem provides a Rails engine that manages the CSP violations reported by
 the client browser (when supported).
 
+This gem was started with CSP v1.0 specification. On Aug 9th, an editor's draft
+of v1.1 was published. This gem currently has not been modified to support it.
+However v1.1 of CSP is spec'd to be backward compatible and from my lecture of
+the spec, I can't see anything that should not work if your browser ups to the
+new version.
+
 **Disclaimer**
 
 This is a rough cut gem for the moment. It won't look like much in the report
 page. However, elements have a class so you can add some CSS style before I
  add some clean ones in the gem.
 
-I promise something cleaner when I'll get to v1 and when the W3C will have
-finalized the spec.
+I promise something cleaner when I'll get to v1.
 
-Upgrade from 0.1.x
-==================
+**Careful**: If migrating from 0.1.x, please follow 
+[these instructions](#upgrade-from-01x)
 
-CAREFUL, 0.2.0 comes with DB changes. I won't do that in a minor after we are at
-v1, but for the moment, I thought it would not trouble too many people.
+**Careful**: If migrating from 0.2.x or below, you can follow 
+[these instructions](#upgrade-from-02x). This is not mandatory.
 
-Make sure to run
-+ rake csp\_report:install:migrations
-+ rake db:migrate
-
-before continuing
-
 What is CSP
 ===========
 
 CSP (Content Security Policy) is a way to limit cross site scripting by relying
 on the browser as a last line of defense. It does not mean the other anti XSS
@@ -58,27 +57,34 @@
 ```
 	gem csp_report
 ```
 Don't forget to run `bundle install` afterwards
 
-1. Run the generator
+1. Run the generator. The engine mount point is configurable. By default it will be 
+**/csp** but you can change that to your liking by passing a parameter to the
+install generator  
+If you want to run the easy install step just after, you can now pass the -a
+param to the install generator and it will execute the csp_declaration generator
+too
 ```shell
-	rails generate csp_report:install
+	rails generate csp_report:install [mount_point_name] [-a]
 ```
-It retrieve the db migration files from the gem and install them  
-It mounts the gem routes in the application  
+It retrieve the db migration files from the gem and copy them in the application  
+It mounts the engine in the application (see routes.rb)  
 *Don't forget to run the `rake db:migrate` command*
 
-1. **EASY INSTALL**: use the helper generator to get your CSP directive skeleton.
+1. **EASY INSTALL**: if you used the *-a* parameter above, you can skip this
+Use the helper generator to get your CSP directive skeleton.
+It will use the mount point that you defined in the install.
 Execute
 ```shell
 	rails generate csp_report:csp_declaration
 ```
 You can then customize the directive in the ApplicationController.
 
-1. *(If you have not followed the previous step)* You need to configure a CSP on your 
-server response, with the *report_uri*
+1. *(If you have not followed the previous step and not used the -a parameter)* 
+You need to configure a CSP on your server response, with the *report_uri*
 parameters pointing to the configured REST resource above. Following the setup
 above, one solution is to find this in your application_controller.rb file:
 ```ruby
 	class ApplicationController
 		protect_from_forgery
@@ -90,11 +96,12 @@
 		end
 	end
 ```
 
 1. You're all set. Accessing *application_root_url*/csp/csp_reports will display
-a list of all the CSP violation that were reported.
+a list of all the CSP violation that were reported (*csp* might be replaced by
+your custom mount point).
 
 Trying it out
 =============
 
 With the policy set as an example above (*script 'self'*), inline javascript is
@@ -108,10 +115,20 @@
 
 in one of your HTML rendered file and launch it in a browser. If the setup is
 correct and you browser supports CSP, the script will not play (no pop-up) and 
 you'll have one more record in the /csp/csp_reports list.
 
+Utilities
+=========
+
+* For general usage, a constant CspReport::MOUNT_POINT is defined with the 
+namespace provided while running the install generator. This constant is
+typically used in the response header construction.
+* For "plugability", as for any engine, rails gives some helper objects. While
+I could not get it to work as I wanted, in a view you can use *csp_report.routes.url_helpers*
+and it will give you access to all the engine URL helpers.
+
 Why using this gem
 ==================
 
 CSP is yet another layer of protection, basically relying on the browser to do
 some level of control. This is a way to prevent some man in the middle attack 
@@ -131,10 +148,43 @@
 case you might gather stats and maybe warn them in one way or another).
 
 To come
 =======
 
+* Customization instructions
+* Support of CSP 1.1 draft spec
 * Eased data mining
+
+Upgrade from 0.1.x
+==================
+
+CAREFUL, 0.2.0 comes with DB changes. I won't do that in a minor after we are at
+v1, but for the moment, I thought it would not trouble too many people.
+
+Make sure to run
+```shell
+rake csp_report:install:migrations
+rake db:migrate
+```
+before continuing
+
+Upgrade from 0.2.x
+==================
+
+Version 0.3.0 comes with a configurable mount point and a couple of helpers that
+are accessible through the generators.
+While not strictly necessary (at least for the moment nothing depends on it),
+I would advise to
+* Edit your config/routes.rb and remove the mount instruction for the engine
+* run the mount generator. You can take this opportunity to configure the mount
+point to be something else than the default 'csp' by simply passing a name:
+```shell
+rails generate csp_report:mount [NAMESPACE]
+```
+* run the initializer generator
+```shell
+rails generate csp_report:initializer_install
+```
 
 License
 =======
 
 This project is under a MIT-LICENSE.