From 928d30769e812e0299086e0812e60f02b62eba26 Mon Sep 17 00:00:00 2001 From: Wagner Corrales Date: Tue, 10 Nov 2020 02:30:14 +0000 Subject: [PATCH] Delete README.md --- README.md | 75 ------------------------------------------------------- 1 file changed, 75 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 2cf5b67..0000000 --- a/README.md +++ /dev/null @@ -1,75 +0,0 @@ -Quart-Csrf -========== - -Quart-Csrf is an extension for `Quart -`_ to provide CSRF protection. -The code is taked from `Flask-WTF -`_ - -Usage ------ - -To enable CSRF protection globally for a Quart app, you have to create an CSRFProtect and -initialise it with the application, - -.. code-block:: python - - from quart_csrf import CSRFProtect - - app = Quart(__name__) - CSRFProtect(app) - -or via the factory pattern, - -.. code-block:: python - - csrf = CSRFProtect() - - def create_app(): - app = Quart(__name__) - csrf.init_app(app) - return app - -Note: CSRF protection requires a secret key to securely sign the token. By default this will -use the QUART app's SECRET_KEY. If you'd like to use a separate token you can set QUART_CSRF_SECRET_KEY. - -HTML Forms: render a hidden input with the token in the form. - -.. code-block:: html - -
- -
- -JavaScript Requests: When sending an AJAX request, add the X-CSRFToken header to it. For example, in jQuery you can configure all requests to send the token. - -.. code-block:: html - - - - - -Contributing ------------- - -Quart-Csrf is developed on `GitLab -`_. You are very welcome to -open `issues `_ or -propose `merge requests -`_. - -Help ----- - -This README is the best place to start, after that try opening an -`issue `_.