diff --git a/README.md b/README.md index b290e8e..d30d3c3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,32 @@ # django-separate-users -separate staff and non staff users with two proxy models. nothing fancy, but as I ended up doing this again and again, this is a simple plug and forget solution, that I'll probably use in many projects from now on. +separate staff and non staff users with two proxy models (FrontendUser and Editor). +Nothing fancy, but as I ended up doing this again and again, this is a simple plug and forget +solution, that I'll probably use in many projects from now on. - staff users can be given the right to edit non staff users (currently not possible, or everyone can make everyone a superuser) -- fieldsets for staff and non staff users can be defined via settings -- less clutter +- fieldsets for staff and non staff users can be defined via settings (not yet) +- better admin list views (filters, is_active, etc) + + +## Usage + +In your settings, add to `INSTALLED_APPS` + + INSTALLED_APPS = [ + ... + 'separate_users', + ... + ] + +Also, you NEED to define a `MIGRATION_MODULES` entry for separate_users. As your UserModel might +be different, we cannot guess the needed migrations, so you'll need to create them yourself. + + MIGRATION_MODULES = { + 'separate_users': 'your_apps.separate_users_migrations', + } + +You'll need to create this folder, with an __init__.py, then you can run +`./manage.py makemigrations` (try --dry-run to see if it works as you would expect). + +As of a django bug, you'll want to run `./manage.py fix_proxy_permissions`, otherwise your non +superusers (but staff) might not be able to edit frontend and/or editor users. \ No newline at end of file