Updated README file

This commit is contained in:
Mohamed El-Kalioby
2019-01-24 19:44:24 +03:00
parent ce6a224818
commit 2af838bfd3
2 changed files with 6 additions and 3 deletions

View File

@@ -1,13 +1,16 @@
# django-mfa2 # django-mfa2
A Django app that handles MFA, it supports TOTP, U2F, FIDO2 U2F (Web Authn), Email Tokens , and Trusted Devices A Django app that handles MFA, it supports TOTP, U2F, FIDO2 U2F (Web Authn), Email Tokens , and Trusted Devices
Web Authencation API (Webauthn) is state-of-the art techology that is expected to replace passwords. [![PyPI version](https://badge.fury.io/py/django-mfa2.svg)](https://badge.fury.io/py/django-mfa2)
Web Authencation API (WebAuthn) is state-of-the art techology that is expected to replace passwords.
![Andriod Fingerprint](https://cdn-images-1.medium.com/max/800/1*1FWkRE8D7NTA2Kn1DrPjPA.png) ![Andriod Fingerprint](https://cdn-images-1.medium.com/max/800/1*1FWkRE8D7NTA2Kn1DrPjPA.png)
For FIDO2, both security keys and android-safetynet are supported. For FIDO2, both security keys and android-safetynet are supported.
In English :), It allows you to verify the user by security keys on PC, Laptops and Fingerprint/PIN on Andriod Phones.
Trusted device is a mode for the user to add a device that doesn't support security keys like iOS and andriod without fingerprints or NFC. Trusted device is a mode for the user to add a device that doesn't support security keys like iOS and andriod without fingerprints or NFC.
**Note**: `U2F and FIDO2 can only be served under secure context (https)` **Note**: `U2F and FIDO2 can only be served under secure context (https)`

View File

@@ -12,7 +12,7 @@ setup(
author='Mohamed El-Kalioby', author='Mohamed El-Kalioby',
author_email = 'mkalioby@mkalioby.com', author_email = 'mkalioby@mkalioby.com',
url = 'https://github.com/mkalioby/django-mfa2/', url = 'https://github.com/mkalioby/django-mfa2/',
long_description=open('README.md').read(),
download_url='https://github.com/mkalioby/django-mfa2/', download_url='https://github.com/mkalioby/django-mfa2/',
license='MIT', license='MIT',
packages=find_packages(), packages=find_packages(),