From b4620c1e475fb43ef5faaaf91c26dc50d119411b Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Wed, 17 Apr 2024 12:15:03 -0500 Subject: [PATCH] feat: update readme (#2) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index bf193c7..4fded73 100644 --- a/README.md +++ b/README.md @@ -40,12 +40,26 @@ isal support for aiohttp +zlib is be a bottleneck for aiohttp, especially for websocket connections. `aiohttp-isal` replaces usage of `zlib` in `aiohttp` with `isal` which is a drop-in faster replacement in most cases. Be sure to read the [isal](https://github.com/pycompression/python-isal) documentation. + ## Installation Install this via pip (or your favourite package manager): `pip install aiohttp-isal` +## Usage + +Enable [isal](https://github.com/pycompression/python-isal) support in aiohttp by calling `enable_isal` + +```python + +import aiohttp_isal + +aiohttp_isal.enable_isal() +aiohttp_isal.disable_isal() +``` + ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):