Commits

Matthew Schinckel committed 74712f0

Added more docs

Comments (0)

Files changed (1)

-==============================
 Update Manager
 ==============================
 
 Update Manager does not update django, or any django apps.
 
 Requirements
-============
+-------------
 
 Django
 
 
 Installation
-============
+----------------
 
 Install using pip or setup.py
 
 Put update_manager into your settings.INSTALLED_APPS.
 
-Create a Software Package using the admin interface.
+Add to your project.urls::
+
+    url(r'^updates/', include('update_manager.urls')),
+
+Usage
+-----------
+
+Create a Software Package using the admin interface.
+
+Create one or more Update Groups.
+
+Create a Release Version each time your software is updated.
+
+Mark which Update Groups should use this Release Version.
+
+Next time a user hits the url /updates/check/, with the data::
+
+    name=<Software Package Name>
+    installed=<Installed Version Number>
+
+They will get a redirect to a Location with the new software if their
+installation requires an upgrade, according to their upgrade group.