Skip to content

Commit

Permalink
feat: update readme (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
bdraco committed Apr 17, 2024
1 parent 6ce232f commit b4620c1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)):
Expand Down

0 comments on commit b4620c1

Please sign in to comment.