From 05c2adefcd11a31f755a7263da52821fec2f90e8 Mon Sep 17 00:00:00 2001 From: Kenta Sato Date: Sun, 11 Jun 2017 15:19:40 +0900 Subject: [PATCH] add codec and stream table in README.md [ci skip] --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11503ab..f3f0c5b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,18 @@ [![TravisCI Status][travisci-img]][travisci-url] [![codecov.io][codecov-img]][codecov-url] -See [TranscodingStreams.jl](https://github.com/bicycle1885/TranscodingStreams.jl) for details. +This package exports following codecs and streams: + +| Codec | Stream | +| ---------------------- | ---------------------------- | +| `GzipCompression` | `GzipCompressionStream` | +| `GzipDecompression` | `GzipDecompressionStream` | +| `ZlibCompression` | `ZlibCompressionStream` | +| `ZlibDecompression` | `ZlibDecompressionStream` | +| `DeflateCompression` | `DeflateCompressionStream` | +| `DeflateDecompression` | `DeflateDecompressionStream` | + +See docstrings and [TranscodingStreams.jl](https://github.com/bicycle1885/TranscodingStreams.jl) for details. [travisci-img]: https://travis-ci.org/bicycle1885/CodecZlib.jl.svg?branch=master [travisci-url]: https://travis-ci.org/bicycle1885/CodecZlib.jl