Skip to content

Commit 5bad57d

Browse files
author
Mishbah
committed
Update README to add a list of Features
1 parent d2dbdd6 commit 5bad57d

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

README.rst

+24-3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ django-modeladmin-reorder
1212
:target: https://coveralls.io/r/mishbahr/django-modeladmin-reorder?branch=master
1313

1414
Custom ordering for the apps and models in the admin app.
15+
1516
You can rename, reorder, cross link, exclude apps or models
1617

1718
Documentation
@@ -62,18 +63,38 @@ Configuration
6263
# Reorder app models
6364
{'app': 'auth', 'models': ('auth.User', 'auth.Group')},
6465

66+
# Exclude models
67+
{'app': 'auth', 'models': ('auth.User', )},
68+
6569
# Cross-linked models
6670
{'app': 'auth', 'models': ('auth.User', 'sites.Site')},
6771

6872
# models with custom name
6973
{'app': 'auth', 'models': (
70-
'auth.User',
71-
{'model': 'auth.Group', 'label': 'User Group'},
74+
'auth.Group',
75+
{'model': 'auth.User', 'label': 'Staff'},
7276
)},
7377
)
7478

7579

7680
Features
7781
--------
7882

79-
* TODO
83+
* Reorder apps in admin index — this will allow you to position
84+
most used apps in top of the page, instead of listing apps
85+
alphabetically. e.g. `sites` app before the `auth` app
86+
87+
* Rename a `app` label easily for third party apps without having
88+
to modify the source code. e.g. rename `auth` app to `Authorisation`
89+
90+
* Reorder models within a `app`. e.g. `auth.User` model before the `auth.Group`
91+
92+
* Exclude any of the models from the app list by not including it
93+
in the `models` config. e.g. Exclude `auth.Group` from app list.
94+
95+
Please note this only excludes the model from the app list and it doesn't protect it from access via url
96+
97+
* Cross link models from multiple apps to make your own app module. e.g. Group 'sites.Site' with the 'auth' app
98+
99+
* Rename individual models in app list. e.g. rename `auth.User` name from 'User' to 'Staff'
100+

docs/usage.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ Usage
3939

4040
# models with custom name
4141
{'app': 'auth', 'models': (
42-
'auth.User',
43-
{'model': 'auth.Group', 'label': 'User Group'},
42+
'auth.Group',
43+
{'model': 'auth.User', 'label': 'Staff'},
4444
)},
4545
)
46+

0 commit comments

Comments
 (0)