Skip to content

Commit e7cbf35

Browse files
committed
Better description
1 parent 68d8828 commit e7cbf35

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
python-isal
22
===========
33

4-
Python bindings for the `isa-l <https://github.com/intel/isa-l>`_ library.
4+
Faster zlib and gzip compatible compression and decompression.
55

6-
The Intel Infrastructure Storage Acceleration Library (isa-l) implements several key
7-
algorithms in `assembly language <https://en.wikipedia.org/wiki/Assembly_language>`_.
8-
This includes the DEFLATE algorithm which is used in ``gzip``.
6+
This package provides Python bindings for the `isa-l
7+
<https://github.com/intel/isa-l>`_ library. The Intel Infrastructure Storage
8+
Acceleration Library (isa-l) implements several key algorithms in `assembly
9+
language <https://en.wikipedia.org/wiki/Assembly_language>`_. This includes
10+
a variety of functions to provide zlib/gzip-compatible compression.
11+
12+
``python-isal`` provides the bindings by offering an ``isal_zlib`` and
13+
``igzip`` module which are usable as drop-in replacements for the ``zlib``
14+
and ``gzip`` modules from the stdlib (with some minor exceptions, see below).
915

1016
Installation
1117
------------

setup.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@
3333
setup(
3434
name="isal",
3535
version="0.1.0-dev",
36-
description="Python bindings for the isa-l library. "
37-
"Much faster zlib/gzip compatible compression and "
38-
"decompression.",
36+
description="Faster zlib and gzip compatible compression and "
37+
"decompression. Python bindings for the isa-l library.",
3938
author="Leiden University Medical Center",
4039
author_email="[email protected]", # A placeholder for now
4140
long_description=Path("README.rst").read_text(),

0 commit comments

Comments
 (0)