Skip to content

Commit c540557

Browse files
authored
Merge pull request #7 from rtfol/update-doc
Update doc
2 parents 59c7098 + cb32574 commit c540557

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848

4949
# General information about the project.
5050
project = u'SSE Client'
51-
copyright = u"2018, Jason Hu"
51+
copyright = u"2018-2019, Jason Hu"
5252
author = u"Jason Hu"
5353

5454
# The version info for the project you're documenting, acts as replacement
@@ -155,7 +155,7 @@
155155
u'SSE Client Documentation',
156156
author,
157157
'aiohttp_sse_client',
158-
'One line description of project.',
158+
'A Server-Sent Event python client base on aiohttp, provides a simple interface to process Server-Sent Event.',
159159
'Miscellaneous'),
160160
]
161161

docs/usage.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,15 @@ Usage
44

55
To use SSE Client in a project::
66

7-
import aiohttp_sse_client
7+
.. code-block:: python
8+
9+
from aiohttp_sse_client import client as sse_client
10+
11+
async with sse_client.EventSource(
12+
'https://stream.wikimedia.org/v2/stream/recentchange'
13+
) as event_source:
14+
try:
15+
async for event in event_source:
16+
print(event)
17+
except ConnectionError:
18+
pass

0 commit comments

Comments
 (0)