Skip to content

Commit 3ef0f76

Browse files
committed
updated readme
1 parent 5f09e30 commit 3ef0f76

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,28 @@ WARNING: `django-rest-registration` is only Python 3 compatible.
1414
* reset password
1515
* change password
1616
* register (change) e-mail
17-
* Modeless (uses cryptographic signing instead of profile models)
17+
* Views are compatible with [django-rest-swagger](https://github.com/marcgibbons/django-rest-swagger)
18+
* Views can be authenticated via session or auth token
19+
* Modeless (uses the user defined by `settings.AUTH_USER_MODEL` and also uses [cryptographic signing](https://docs.djangoproject.com/en/dev/topics/signing/) instead of profile models)
20+
* Uses [password validation](https://docs.djangoproject.com/en/dev/topics/auth/passwords/#password-validation)
1821
* Heavily tested (Above 99% code coverage)
1922

2023

2124
## Current limitations
2225

2326
* Supports only one email per user (as model field)
24-
* Heavily based on Django an Django-REST-Framework
27+
* Heavily based on Django (1.9+) an Django-REST-Framework (3.3.2+)
2528
* Python3 only
29+
* No JWT support
2630

2731

2832
## Installation
2933

30-
You can install `django-rest-registration` via pip:
34+
You can install `django-rest-registration` lastest version via pip:
3135

3236
pip install django-rest-registration
3337

34-
Or:
38+
Or install directly from source via GitHub:
3539

3640
pip install git+https://github.com/szopu/django-rest-registration
3741

@@ -62,9 +66,22 @@ After that, you can use the urls in your urlconfig, for instance:
6266

6367
## Configuration
6468

65-
6669
You can configure `django-rest-registraton` using the `REST_REGISTRATION`
6770
setting in your django settings (similarly to `django-rest-framework`).
71+
72+
Below is sample, minimal config you can provide in your django settings which will satisfy the system checks:
73+
74+
REST_REGISTRATION = {
75+
'REGISTER_VERIFICATION_ENABLED': False,
76+
77+
'RESET_PASSWORD_VERIFICATION_URL': '/reset-password/',
78+
79+
'REGISTER_EMAIL_VERIFICATION_ENABLED': False,
80+
81+
'VERIFICATION_FROM_EMAIL': 'no-reply@example.com',
82+
}
83+
84+
6885
The default values are:
6986

7087
REST_REGISTRATION = {
@@ -116,8 +133,13 @@ The default values are:
116133

117134
'VERIFICATION_FROM_EMAIL': None,
118135
'VERIFICATION_REPLY_TO_EMAIL': None,
136+
137+
'SUCCESS_RESPONSE_BUILDER': (
138+
'rest_registration.utils.build_default_success_response')
139+
119140
}
120141

121142
The `USER_*` fields can be set directly in the user class
122143
(specified by `settings.AUTH_USER_MODEL`) without using
123-
the `USER_` prefix (`EMAIL_FIELD`, etc.).
144+
the `USER_` prefix (`EMAIL_FIELD`, etc.). These settings will override these
145+
provided in `settings.REST_REGISTRATION`.

0 commit comments

Comments
 (0)