Skip to content

Commit 242e8f8

Browse files
committed
📚 added more details to README.md
1 parent 882f7ad commit 242e8f8

File tree

2 files changed

+75
-1
lines changed

2 files changed

+75
-1
lines changed

LICENSE.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The zlib/libpng License
2+
=======================
3+
4+
Copyright (c) 2022 Vasanth Developer
5+
6+
This software is provided 'as-is', without any express or implied warranty. In
7+
no event will the authors be held liable for any damages arising from the use of
8+
this software.
9+
10+
Permission is granted to anyone to use this software for any purpose, including
11+
commercial applications, and to alter it and redistribute it freely, subject to
12+
the following restrictions:
13+
14+
1. The origin of this software must not be misrepresented; you must not claim
15+
that you wrote the original software. If you use this software in a product,
16+
an acknowledgment in the product documentation would be appreciated but is
17+
not required.
18+
19+
2. Altered source versions must be plainly marked as such, and must not be
20+
misrepresented as being the original software.
21+
22+
3. This notice may not be removed or altered from any source distribution.

README.md

+53-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
## Flask Server Sent Events
1+
<h1 align="center">
2+
<pre>flask-queue-sse</pre>
3+
</h1>
4+
<p align="center">
5+
<strong>
6+
A simple implementation of <a href="https://web.dev/eventsource-basics">Server-Sent Events</a> for <a
7+
href="https://flask.palletsprojects.com">Flask</a> that
8+
doesn't require Redis pub/sub.
9+
</strong>
10+
</p>
11+
<p align="center">
12+
<a target="_blank" rel="noopener" href="https://pypi.org/project/flask-queue-sse">
13+
<img src="https://img.shields.io/pypi/v/flask-queue-sse?style=flat-square" alt="">
14+
</a>
15+
<a target="_blank" rel="noopener" href="https://pypi.org/project/flask-queue-sse/#history">
16+
<img src="https://img.shields.io/pypi/dm/flask-queue-sse" alt="">
17+
</a>
18+
<a href="https://github.com/vsnthdev/flask_queue_sse/issues">
19+
<img src="https://img.shields.io/github/issues/vsnthdev/flask_queue_sse.svg?style=flat-square" alt="">
20+
</a>
21+
<a href="https://github.com/vsnthdev/flask_queue_sse/commits/main">
22+
<img src="https://img.shields.io/github/last-commit/vsnthdev/flask_queue_sse.svg?style=flat-square" alt="">
23+
</a>
24+
</p>
25+
<br>
26+
27+
<!-- header -->
28+
29+
> Tweet me <a target="_blank" rel="noopener" href="https://vas.cx/twitter">@vsnthdev</a>, I would love to know your
30+
opinion/experience on this project 😍
31+
32+
<!-- why this package? -->
33+
34+
## 💿 Installation
35+
36+
```
37+
pip install flask-queue-sse
38+
```
39+
40+
<!-- quick start -->
41+
42+
<!-- docs to build the project -->
43+
44+
<!-- footer -->
45+
46+
## 📰 License
47+
> The **flask-queue-sse** project is released under the [Zlib license](https://github.com/vsnthdev/flask-queue-sse/blob/main/LICENSE.md). <br> Developed &amp; maintained By Vasanth Srivatsa. Copyright 2023 © Vasanth Developer.
48+
<hr>
49+
50+
> <a href="https://vsnth.dev" target="_blank" rel="noopener">vsnth.dev</a> &nbsp;&middot;&nbsp;
51+
> YouTube <a href="https://vas.cx/videos" target="_blank" rel="noopener">@vasanthdeveloper</a> &nbsp;&middot;&nbsp;
52+
> Twitter <a href="https://vas.cx/twitter" target="_blank" rel="noopener">@vsnthdev</a> &nbsp;&middot;&nbsp;
53+
> Discord <a href="https://vas.cx/discord" target="_blank" rel="noopener">Vasanth Developer</a>

0 commit comments

Comments
 (0)