Mikhail Korobov avatar Mikhail Korobov committed 6473ea4

Updated README

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.
 
 * ``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.
 
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.