initial commit
[ckanext-datagovau.git] / README.rst
blob:a/README.rst -> blob:b/README.rst
--- a/README.rst
+++ b/README.rst
@@ -2,11 +2,12 @@
 
 It comprises:
 
-* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when
-  loaded, overrides various settings in the core ``ini``-file to provide:
-  * A path to local customisations of the core templates and available licenses database
-  * A custom Package edit form
-  * A custom n3/rdf output format
+* A custom Package edit form that defaults to cc-by licence
+* Replaces links with http/https protocol independent versions
+* Provides HTML to users to embed data previews on their own website
+* A cut down licenses.json file
+
+This extension is complemented by ckanext-agls for AGLS metadata, ckanext-googleanalytics for Google Analytics tracking of API usage and ckanext-dga-stats for the customised site statistics page.
 
 Installation
 ============
@@ -17,5 +18,9 @@
 
 Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.
 
+To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json``
+or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file
+and set ``licenses_group_url = file://%(here)s/licenses.json``
 
 
+