Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fill readme #198

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ Complete table of extras bellow:
+-----------------------------------+------------------------------------------------+
| ``pip install aiomisc[rich]`` | You might using rich_ for logging |
+-----------------------------------+------------------------------------------------+
| ``pip install aiomisc[uvicorn]`` | For running ASGI_ application using uvicorn_ |
+-----------------------------------+------------------------------------------------+
| ``pip install aiomisc[uvloop]`` | use uvloop_ as a default event loop |
+-----------------------------------+------------------------------------------------+

Expand All @@ -111,6 +113,7 @@ Complete table of extras bellow:
.. _rich: https://pypi.org/project/rich
.. _sentry: https://sentry.io/
.. _uvloop: https://pypi.org/project/uvloop
.. _uvicorn: https://pypi.org/project/uvicorn

You can combine extras values by separating them with commas, for example:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@ HTTPS server. You must pass SSL-required options (see ``TLSServer`` class).
.. uvicorn-service:

uvicorn service
++++++++++++
+++++++++++++++

.. warning::

Expand Down