Daniel Greenfeld avatar Daniel Greenfeld committed 3478e54

Filling out the README

Comments (0)

Files changed (1)

 
 Put cmsplugin-htmlsitemap into your python path::
 
-    pip install -e hg+https://cartwheel@bitbucket.org/cartwheel/cmsplugin-htmlsitemap#egg=cmsplugin-htmlsitemap
+    pip install -e hg+https://cartwheel@bitbucket.org/cartwheel/cmsplugin-htmlsitemap#egg=cmsplugin-htmlsitemap
+    
+Add the plugin to your INSTALLED_APPS in settings.py::
+
+    INSTALLED_APPS = (
+    ...
+    'cmsplugin_htmlsitemap',
+    ...
+    
+    )
+
+Usage
+=====
+
+To get the sitemap to display on a page:
+
+#. Go to the admin for the page you on which you want the sitemap to show up.
+#. Choose **HTML Sitemap Plugin** from the available plugins.
+#. Click **+ Add Plugin**
+#. Click '**Save**' in the actual plugin. You should see the message 'Plugin saved successfully.'
+#. Click **Save ** at the bottom of the django admin page.
+
+Your page should now show the sitemap!
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.