Skip to content

Commit 9daa4a4

Browse files
docs(readme): updated readme
1 parent 2ac9fc6 commit 9daa4a4

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,18 @@
44
<br>
55
</h1>
66

7-
<h4 align="center">Adds support for Server-side Session to your Flask application.</h4>
7+
<h4 align="center">Adds support for Server-side Session to your [Flask](https://flask.palletsprojects.com) application.</h4>
88

9-
10-
Welcome to Flask-Session's documentation. Flask-Session is an extension for [Flask](https://flask.palletsprojects.com) that adds support for Server-side `Session` to your application.
9+
<p align="center">
10+
<a href="https://codecov.io/gh/christopherpickering/flask-session2" > <img src="https://codecov.io/gh/christopherpickering/flask-session2/branch/master/graph/badge.svg?token=97G1F34PKY"/> </a>
11+
<a href="https://www.codacy.com/gh/christopherpickering/flask-session2/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=christopherpickering/flask-session2&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/4f05bcca902448b1aecacc51aa94d363"/></a>
12+
<a href="https://pepy.tech/project/flask-session2">
13+
<img src="https://pepy.tech/badge/flask-session2" alt="Downloads">
14+
</a>
15+
<a href="https://pypi.org/project/flask-session2/">
16+
<img src="https://img.shields.io/pypi/v/flask-session2" alt="Pypi Download">
17+
</a>
18+
</p>
1119

1220

1321
## Installation
@@ -59,7 +67,7 @@ sess.init_app(app)
5967
The following configuration values exist for Flask-Session. Flask-Session loads these values from your Flask application config, so you should configure
6068
your app first before you pass it to Flask-Session. Note that these values cannot be modified after the ``init_app`` was applyed so make sure to not modify them at runtime.
6169

62-
We are not supplying something like ``SESSION_REDIS_HOST`` and ``SESSION_REDIS_PORT``, if you want to use the ``RedisSessionInterface``, you should configure ``SESSION_REDIS`` to your own ``redis.Redis`` instance. This gives you more flexibility, like maybe you want to use the same ``redis.Redis`` instance for cache purpose too, then you do not need to keep two ``redis.Redis`` instance in the same process.
70+
We are not supplying something like `SESSION_REDIS_HOST` and `SESSION_REDIS_PORT`, if you want to use the `RedisSessionInterface`, you should configure `SESSION_REDIS` to your own `redis.Redis` instance. This gives you more flexibility, like maybe you want to use the same `redis.Redis` instance for cache purpose too, then you do not need to keep two `redis.Redis` instance in the same process.
6371

6472
The following configuration values are builtin configuration values within Flask itself that are related to session. **They are all understood by
6573
Flask-Session, for example, you should use PERMANENT_SESSION_LIFETIME to control your session lifetime.**
@@ -109,15 +117,15 @@ session but fail on setting.
109117

110118
### `RedisSessionInterface`
111119

112-
Uses the Redis key-value store as a session backend. ([redis-py](https://pypi.org/project/redis/) required)
120+
Uses the Redis key-value store as a session backend. ([redis-py](https://github.com/andymccurdy/redis-py) required)
113121

114122
Relevant configuration values:
115123

116124
- SESSION_REDIS
117125

118126
### `MemcachedSessionInterface`
119127

120-
Uses the Memcached as a session backend. ([pymemcache](https://pypi.org/project/pymemcache/) required)
128+
Uses the Memcached as a session backend. ([pylibmc](http://sendapatch.se/projects/pylibmc/) or [memcache](https://github.com/linsomniac/python-memcached) required)
121129

122130
- SESSION_MEMCACHED
123131

@@ -145,3 +153,7 @@ Uses SQLAlchemy as a session backend. ([Flask-SQLAlchemy](https://pythonhosted.o
145153

146154
- SESSION_SQLALCHEMY
147155
- SESSION_SQLALCHEMY_TABLE
156+
157+
## Credits
158+
159+
This project is a fork of [flask-session](https://github.com/fengsp/flask-session), created by [Shipeng Feng](https://github.com/fengsp).

0 commit comments

Comments
 (0)