From 65e16e05708d771c4b4d89c30742262bbedbdd91 Mon Sep 17 00:00:00 2001 From: Rohit Sankaran Date: Mon, 25 Feb 2013 10:51:33 -0600 Subject: [PATCH] Added documentation for 301 responses Documented the addition of the permanent parameter. --- README.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index dd43bf9..f0b085c 100644 --- a/README.rst +++ b/README.rst @@ -38,18 +38,27 @@ Flask-SSLify also provides your application with an HSTS policy. By default, HSTS is set for on year (31536000 seconds). -You can change the duration by passing the `age` parameter:: +You can change the duration by passing the ``age`` parameter:: sslify = SSLify(app, age=300) -If you'd like to include subdomains in your HSTS policy, set the `subdomains` parameter:: +If you'd like to include subdomains in your HSTS policy, set the ``subdomains`` parameter:: sslify = SSLify(app, subdomains=True) +HTTP 301 Redirects +------------------ + +By default, the redirect is issued with a HTTP 302 response. You can change that to a HTTP 301 response +by passing the ``permanent`` parameter:: + + sslify = SSLify(app, permanent=True) + + Install ------- Installation is simple too:: - $ pip install Flask-SSLify \ No newline at end of file + $ pip install Flask-SSLify