moj_template 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b05a206676891278338458e932b35ce1da2ca4
-  data.tar.gz: ac3e9446fbe5ac85759b43324a0c4d0d34d5a77a
+  metadata.gz: e798207d94a88fc8993897fbe6a0222a9c64a340
+  data.tar.gz: 64848fd216114cf62a7e9887aa9e3437c5f9111d
 SHA512:
-  metadata.gz: 617d074049a1153464a0748b4b4faa3cd40ada17e899f9fac7d7688b8912b1cd88da2c32fcaeaafc74bcb61af7a36b25a0237e081f7822d97bfe31503daea55a
-  data.tar.gz: 39afa24212b6f6837fa9d1f7ded5a89843c538b921e92b8bfdf54edc22c01cfe27a78c0c66afa03613a11eb52010e3fa7c6c52ac5442f40677142f6014c5af4f
+  metadata.gz: 7d258eca9a727d5de32aa3694781ab8d638cdfd160af7d18f014902605d5108b36bd140133b2cfe3a31fc55861e3f71fefb83772bdb7f2ae73cee9ee428f8f54
+  data.tar.gz: 692216f2b2ee4ffe6f2e683f23b3463b4392ebf40e43f57c586cf2e038acdb052c98a9246ff3a359facaae9256d6aa0265f413e226626c918dba6f8ee4901d38

data/README.md

@@ -25,11 +25,11 @@ At present this generates 5 output formats:
 
 To use it, add this line to your application's Gemfile (change the tag to the version you would like to use):
 
-    gem 'moj_template', git: 'https://github.com/ministryofjustice/moj_template.git', tag: 'v0.1.0'
+    gem 'moj_template', '~> 0.1.0'
 
 And then execute:
 
-    $ bundle
+    bundle
 
 You can then use the `moj_template` layout in your app.  If you need to extend the layout you can use [nested layouts](http://guides.rubyonrails.org/layouts_and_rendering.html#using-nested-layouts).
 
@@ -56,21 +56,31 @@ In order for these files to work, you will need to set a number of variables in
 
 ### Django version
 
-To use the django package, add it to your app using:
+To use the django package, add the following package to `requirements.txt`:
 
-    pip install moj_template
+    django-moj-template==0.1.0
 
-Then extend your base template from the moj_template using:
+Then run:
+
+    pip install -r requirements.txt
+
+Add `moj_template` to your `INSTALLED_APPS` in your `settings.py` file. Eg:
+
+  INSTALLED_APPS = (
+    ...
+    'moj_template',
+    ...
+  )
+
+Then to use the template in your application extend your base template from the `moj_template` using:
 
     {% extends 'moj_template/base.html' %}
 
 #### Django Config
 
-You will be required to set up some additional config to use the package. Add the following to your `TEMPLATE_CONTEXT_PROCESSORS`:
-
-    "{app_path}.apps.core.context_processors.globals"
+You will be required to set up some additional config to use the package.
 
-Then include the following in a new file called `apps/core/context_processors.py`:
+Create a new file called `{app_path}/context_processors.py` with the following contents:
 
     def globals(request):
       return {
@@ -82,6 +92,10 @@ Then include the following in a new file called `apps/core/context_processors.py
         'ga_id': '' # Google Analytics ID (Tracking ID for the service)
       }
 
+Then add the following to your `TEMPLATE_CONTEXT_PROCESSORS` in `settings.py`:
+
+    "{app_path}.context_processors.globals"
+
 ### Play version
 
 To generate the tarball of Play Framework templates run `bundle exec rake build:play`. This will produce a tarball in the `pkg` directory.
@@ -104,6 +118,17 @@ To generate the folder of Liquid templates run `bundle exec rake build:liquid`.
 
 To generate the tarball, run the `bundle exec rake build:tar` rake task. This will produce a tarball in the `pkg` directory.
 
+## Publishing
+
+After an accepted contribution (pull request merged into master) you must checkout master and run the following command to publish the current versions:
+
+    bundle exec rake publish
+
+This will trigger a build and on success publish the following packages:
+
+* [A gem on RubyGems.org](https://rubygems.org/gems/moj_template)
+* [A Django python package](https://pypi.python.org/pypi/django-moj-template)
+
 ## Development
 
 The source files are in the `/source` directory.  The `compile` rake task builds the `/app` contents from these sources.  This process involves the following:

data/lib/moj_template/version.rb

@@ -1,3 +1,3 @@
 module MojTemplate
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moj_template
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Dom Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails