diff --git a/README.rst b/README.rst index 301c5e19dc..fa178bc137 100644 --- a/README.rst +++ b/README.rst @@ -46,7 +46,7 @@ privacyIDEA privacyIDEA is an open solution for strong two-factor authentication like OTP tokens, SMS, smartphones or SSH keys. -Using privacyIDEA you can enhance your existing applications like local login +Using privacyIDEA you can enhance your existing aplications like local login (PAM, Windows Credential Provider), VPN, remote access, SSH connections, access to web sites or web portals with a second factor during authentication. Thus boosting the security of your @@ -68,7 +68,7 @@ stored. This is achieved by its totally modular architecture. privacyIDEA is not only open as far as its modular architecture is concerned. But privacyIDEA is completely licensed under the AGPLv3. -It supports a wide variety of authentication devices like OTP tokens +It suports a wide variety of authentication devices like OTP tokens (HMAC, HOTP, TOTP, OCRA, mOTP), Yubikey (HOTP, TOTP, AES), FIDO U2F, as well as FIDO2 WebAuthn devices like Yubikey and Plug-Up, smartphone Apps like Google Authenticator, FreeOTP, Token2 or TiQR, SMS, Email, SSH keys, x509 certificates @@ -77,10 +77,10 @@ and Registration Codes for easy deployment. privacyIDEA is based on Flask and SQLAlchemy as the python backend. The web UI is based on angularJS and bootstrap. A MachineToken design lets you assign tokens to machines. Thus you can use -your Yubikey to unlock LUKS, assign SSH keys to SSH servers or use Offline OTP +your Yubikey to unlock LUKS, asign SSH keys to SSH servers or use Offline OTP with PAM. -You may join the discourse discussion forum to give feedback, help other users, +You may join the discourse discusion forum to give feedback, help other users, discuss questions and ideas: https://community.privacyidea.org @@ -169,7 +169,7 @@ Code structure The database models are defined in ``models.py`` and tested in tests/test_db_model.py. -Based on the database models there are the libraries ``lib/config.py`` which is +Based on the database models there are the libraries ``lib/config.py`` whch is responsible for basic configuration in the database table ``config``. And the library ``lib/resolver.py`` which provides functions for the database table ``resolver``. This is tested in tests/test_lib_resolver.py.