update README.md [ci skip]

JuliaIO · Jun 5, 2017 · 57a1f80 · 57a1f80
1 parent c87d2b8
commit 57a1f80
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,3 +12,10 @@ TranscodingStreams.jl
 [codecov-url]: http://codecov.io/github/bicycle1885/TranscodingStreams.jl?branch=master
 [docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
 [docs-latest-url]: https://bicycle1885.github.io/TranscodingStreams.jl/latest/
+
+TranscodingStreams.jl is a package for transcoding data streams. Transcoding can
+be any codec. For example, following packages define lossless compression and
+decompression codecs:
+- [CodecZlib.jl](https://github.com/bicycle1885/CodecZlib.jl)
+- [CodecZstd.jl](https://github.com/bicycle1885/CodecZstd.jl)
+- [CodecBzip2.jl](https://github.com/bicycle1885/CodecBzip2.jl)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -25,7 +25,7 @@ Codecs are defined in other packages listed below:
     - `ZlibDecompression` (`ZlibDecompressionStream`)
     - `DeflateCompression` (`DeflateCompressionStream`)
     - `DeflateDecompression` (`DeflateDecompressionStream`)
-- [CodecZngstd.jl](https://github.com/bicycle1885/CodecZstd.jl)
+- [CodecZstd.jl](https://github.com/bicycle1885/CodecZstd.jl)
     - `ZstdCompression` (`ZstdCompressionStream`)
     - `ZstdDecompression` (`ZstdDecompressionStream`)
 - [CodecBzip2.jl](https://github.com/bicycle1885/CodecBzip2.jl)