Commits

Mikhail Korobov committed 6473ea4

Updated README

  • Participants
  • Parent commits 3a0cb12

Comments (0)

Files changed (2)

 
 * ``queryset`` - Required. Albums will be attached to objects in this queryset.
 
-* ``object_regex`` - Optional, default is '\d+'. It should be a regular 
-expression for object used in URL.
+* ``object_regex`` - Optional, default is '\d+'. It should be a URL regular 
+expression for object in URL. You should use smth. like '[\w\d-]+' for
+slugs.
 
-* ``lookup_field`` - Optional, default is 'pk'. It is a field name to lookup
-with data from URL. It may contain ``__`` and follow relations 
-(ex.: `userprofile__slug`) 
+* ``lookup_field`` - Optional, default is 'pk'. It is a field name to lookup.
+It may contain ``__`` and follow relations (ex.: `userprofile__slug`).
 
 * ``app_name`` - Optional, default value is 'album'. Used by url namespaces stuff.
 

File README.creole

 * ``queryset`` - Required. Albums will be attached to objects in this queryset.
 
 
-* ``object_regex`` - Optional, default is '\d+'. It should be a regular 
-expression for object used in URL.
+* ``object_regex`` - Optional, default is '\d+'. It should be a URL regular 
+expression for object in URL. You should use smth. like '[\w\d-]+' for
+slugs.
 
-* ``lookup_field`` - Optional, default is 'pk'. It is a field name to lookup
-with data from URL. It may contain ``__`` and follow relations 
-(ex.: `userprofile__slug`) 
+* ``lookup_field`` - Optional, default is 'pk'. It is a field name to lookup.
+It may contain ``__`` and follow relations (ex.: `userprofile__slug`).
 
 * ``app_name`` - Optional, default value is 'album'. Used by url namespaces stuff.