Skip to content

Commit 8057936

Browse files
committed
polish README
1 parent a0f55a0 commit 8057936

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,27 @@
1010
[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)
1111
[![Contribute](https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter)](https://github.com/jupyterhub/nativeauthenticator/blob/master/CONTRIBUTING.md)
1212

13-
A simple authenticator for small-medium size [JupyterHub](http://github.com/jupyter/jupyterhub/) applications.
13+
This is a relatively simple authenticator for small or medium-sized [JupyterHub](http://github.com/jupyter/jupyterhub/) applications. Signup and authentication are implemented as native to JupyterHub without relying on external services.
1414

15-
Native Authenticator provides the following features:
15+
NativeAuthenticator provides the following features:
1616

1717
* New users can signup on the system;
18-
* New users can be blocked of accessing the system and need an admin authorization;
19-
* Option of increase password security by avoiding common passwords or minimum password length;
20-
* Option to block users after a number attempts of login;
21-
* Option of open signup and no need for initial authorization;
22-
* Option of adding more information about users on signup.
23-
18+
* New users can be blocked from accessing the system awaiting admin authorization;
19+
* Option of enforcing password security by disallowing common passwords and/or requiring a minimum password length;
20+
* Option to block users after a set number of failed login attempts;
21+
* Option of open signup without need for initial authorization;
22+
* Option of asking more information about users on signup (e-mail).
23+
* Option of requiring users to agree with given Terms of Service;
24+
* Option of protection against scripting attacks via reCAPTCHA;
25+
* Option for users with a org e-mail address to self-approve via secure link;
2426

2527
## Documentation
2628

27-
Documentation is available [here](https://native-authenticator.readthedocs.io)
28-
29+
The latest documentation is available [here](https://native-authenticator.readthedocs.io).
2930

3031
## Running tests
3132

32-
To run the tests locally, you can install the development dependencies:
33+
To run the tests locally, you can install the development dependencies like so:
3334

3435
`$ pip install -r dev-requirements.txt`
3536

0 commit comments

Comments
 (0)