Skip to content

Commit 3cd196c

Browse files
authored
update README.md (#46)
1 parent ded9b77 commit 3cd196c

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,23 @@ Each codec has an alias to its transcoding stream type for ease of use. For
6060
example, `GzipCompressorStream{S} = TranscodingStream{GzipCompressor,S} where
6161
S<:IO`.
6262

63+
Consult the [docs][docs-latest-url] for more details and examples.
64+
6365
## Codec packages
6466

67+
TranscodingStreams.jl offers I/O interfaces to users. It also offers a protocol
68+
suite to communicate with various codecs. However, specific codecs are not
69+
included in this package except the `Noop` codec, which does nothing to data.
70+
The user need to install codecs as a plug-in to do something meaningful.
71+
72+
The following codec packages support the protocol suite:
6573
- [CodecZlib.jl](https://github.com/bicycle1885/CodecZlib.jl)
6674
- [CodecBzip2.jl](https://github.com/bicycle1885/CodecBzip2.jl)
6775
- [CodecXz.jl](https://github.com/bicycle1885/CodecXz.jl)
6876
- [CodecZstd.jl](https://github.com/bicycle1885/CodecZstd.jl)
6977
- [CodecLz4.jl](https://github.com/invenia/CodecLz4.jl) by Invenia.
7078
- [CodecBase.jl](https://github.com/bicycle1885/CodecBase.jl)
7179

72-
Consult the [docs][docs-latest-url] for more details and examples.
73-
7480
[travisci-img]: https://travis-ci.org/bicycle1885/TranscodingStreams.jl.svg?branch=master
7581
[travisci-url]: https://travis-ci.org/bicycle1885/TranscodingStreams.jl
7682
[codecov-img]: http://codecov.io/github/bicycle1885/TranscodingStreams.jl/coverage.svg?branch=master

0 commit comments

Comments
 (0)