Merge lp:~bloodearnest/charms/precise/gunicorn/fix-readme into lp:~charmers/charms/precise/gunicorn/trunk

[Simon Davy]

Update README with r4 notes and correct example.

Update README with r4 notes and correct example.

[lp:~bloodearnest/charms/precise/gunicorn/fix-readme]

38. By Simon Davy on 2014-04-23

typos and spelling

=== modified file 'README.md'
--- README.md	2013-08-02 19:14:04 +0000
+++ README.md	2014-04-23 09:14:22 +0000
@@ -6,10 +6,10 @@
 
 # How to configure the charm
 
-To deploy a charm with this subordinate it must minimaly:
+To deploy a charm with this subordinate it must minimally:
 
  1. Provide the wsgi interface.
- 1. Set the `working_dir` relation variable in the wsgi hook.
+ 2. Set the `working_dir` relation variable in the wsgi hook.
 
 The configuration of Gunicorn will use the variable pass by
 the relation hook first. If there are not define it will
@@ -17,24 +17,39 @@
 
 # Example deployment
 
- 1. Deployment with python-moinmoin for example::
+ 1. Deployment with python-django for example::
 
         juju bootstrap
-        juju deploy --config mywiki_with_wsgi_settings.yaml python-moinmoin
+        juju deploy python-django
+        juju deploy postgresql
         juju deploy gunicorn
-        juju add-relation gunicorn python-moinmoin
-        juju expose python-moinmoin
+        juju add-relation python-django postgresql:db
+        juju add-relation gunicorn python-django
+        juju expose python-django
 
- 1. Accessing your new wiki should be ready at::
+ 2. Accessing your new django app should be ready at::
 
         http://<machine-addr>:8080/
 
-   To find out the public address of gunicorn/python-moinmoin, look for it in
+   To find out the public address of gunicorn/python-django, look for it in
    the output of the `juju status` command.
    I recommend using a reverse proxy like Nginx in front of Gunicorn. 
 
 # Changelog
 
+4:
+
+Notable changes:
+
+- re-add support for env_extra parameter that was dropped in r3, but with new
+  standard shell format.  e.g. env_extra="FOO=BAR BAZ=QUX". Also supports old
+  r2 format (env_extra="'foo': 'bar', 'baz': 'qux'") to provide an upgrade
+  path.
+- if upgrading from r1 or r2, the old gunicorn config is removed, leaving just
+  the custom upstart job.
+
+No backwards incompatible changes.
+
 3:
 
 Notable changes:
@@ -49,4 +64,5 @@
 - no start/stop hook anymore use related charms instead.
 - no configuration change directly on the charm anymore, use related charms instead.
 - no access logging by default
-- exposing a port must now be done in the linked charm instead of this one
 \ No newline at end of file
+- exposing a port must now be done in the linked charm instead of this one
+