Skip to content

Commit

Permalink
Add content back into README.rst as github doesn't recognize toctree
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanunderwood committed Jun 25, 2016
1 parent bb76baa commit 7cf74d6
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,49 @@ python-lz4

.. image:: https://secure.travis-ci.org/python-lz4/python-lz4.png?branch=master

Introduction
============
This package provides python bindings for the `lz4 compression library
<https://cyan4973.github.io/lz4//>`_ by Yann Collet.

At this time the project contains bindings for the LZ4 block format
and the LZ4 frame format. Patches implementing bindings for the LZ4
stream format would be readily accepted!

Install
=======
The package is hosted on `PyPI <http://pypi.python.org/pypi/lz4>`_::

$ pip install lz4
$ easy_install lz4

Documenation
============
Full documentation is included with the project. The documentation is
generated using Sphinx.

Licensing
=========
Code specific to this project is covered by the `BSD 3-Clause License
<http://opensource.org/licenses/BSD-3-Clause>`_


Contributors
============
- Jonathan Underwood combined the block and frame modules into a
coherent single project with many fixes and cleanups including
updating the block format support to use the tunable accelerated and
high compression functinos
- Steve Morin wrote the original lz4 block bindings
- Christopher Jackson wrote the original lz4 frame bindings as part of
the `lz4tools <https://github.com/darkdragn/lz4tools>`_ project
- Mathew Rocklin added support for dropping the GIL to the block
module, Travis testing support
- Antoine Martin added initial support for fast compression support in
the block library



.. toctree::
docs/intro.rst
docs/install.rst
Expand Down

0 comments on commit 7cf74d6

Please sign in to comment.