Browse Source

Update readme and example urls

David Cramer 14 years ago
parent
commit
74bb13606a
2 changed files with 11 additions and 17 deletions
  1. 9 4
      README.rst
  2. 2 13
      example_project/urls.py

+ 9 - 4
README.rst

@@ -118,12 +118,17 @@ You can also use the ``exc_info`` and ``extra=dict(url=foo)`` arguments on your
 Usage
 =====
 
-You will find two new admin panels in the automatically built Django administration:
+Set up a viewer server (or use your existing application server) and add dblog to your INSTALLED_APPS and your included URLs::
 
-* Messages (Message)
-* Message summaries (GroupedMessage)
+	# urls.py
+	urlpatterns = patterns('',
+	    (r'^admin/', include(admin.site.urls)),
+	    (r'^dblog/', include('dblog.urls')),
+	)
+
+Now enjoy your beautiful new error tracking at ``/dblog/``.
 
-It will store every single error inside of the `Messages` model, and it will store a collective, or summary, of errors inside of `Message batches` (this is more useful for most cases). If you are using this on multiple sites with the same database, the `Messages` table also contains the SITE_ID for which it the error appeared on.
+For the technical, here's some further docs:
 
 If you wish to access these within your own views and models, you may do so via the standard model API::
 

+ 2 - 13
example_project/urls.py

@@ -1,19 +1,8 @@
 from django.conf.urls.defaults import *
 
-# Uncomment the next two lines to enable the admin:
-# from django.contrib import admin
-# admin.autodiscover()
+admin.autodiscover()
 
 urlpatterns = patterns('',
-    # Example:
-    # (r'^example_project/', include('example_project.foo.urls')),
-
-    # Uncomment the admin/doc line below and add 'django.contrib.admindocs' 
-    # to INSTALLED_APPS to enable admin documentation:
-    # (r'^admin/doc/', include('django.contrib.admindocs.urls')),
-
-    # Uncomment the next line to enable the admin:
-    # (r'^admin/', include(admin.site.urls)),
-    
+    (r'^admin/', include(admin.site.urls)),
     (r'^', include('dblog.urls')),
 )