@@ -9,8 +9,24 @@ TranscodingStreams.jl
9
9
10
10
![ TranscodingStream] ( /docs/src/assets/transcodingstream.png )
11
11
12
- TranscodingStreams.jl is a package for transcoding data streams. There are two
13
- kinds of APIs:
12
+ TranscodingStreams.jl is a package for transcoding data streams, which is:
13
+ - ** fast** : small overhead and specialized methods,
14
+ - ** consistent** : basic I/O operations you already know will work as you expect,
15
+ - ** generic** : support any I/O objects like files, buffers, pipes, etc., and
16
+ - ** extensible** : you can define a new codec to transcode data.
17
+
18
+ ## Installation
19
+
20
+ ``` julia
21
+ Pkg. add (" TranscodingStreams" )
22
+ ```
23
+
24
+ Installing a [ codec package] ( #codec-packages ) will install
25
+ TranscodingStreams.jl as well, and so in general you don't need to explicitly
26
+ install it.
27
+
28
+ ## Usage
29
+
14
30
``` julia
15
31
using TranscodingStreams, CodecZlib
16
32
@@ -40,10 +56,12 @@ array = transcode(GzipDecompression(), array)
40
56
@assert text == String (array)
41
57
```
42
58
43
- Each codec has an alias for its transcoding stream type. For example,
44
- ` GzipCompressionStream{S} = TranscodingStream{GzipCompression,S} where S<:IO ` .
59
+ Each codec has an alias to its transcoding stream type for ease of use. For
60
+ example, `GzipCompressionStream{S} = TranscodingStream{GzipCompression,S} where
61
+ S<: IO `.
62
+
63
+ ## Codec packages
45
64
46
- The following packages support the interfaces of TranscodingStreams.jl:
47
65
- [ CodecZlib.jl] ( https://github.com/bicycle1885/CodecZlib.jl )
48
66
- [ CodecBzip2.jl] ( https://github.com/bicycle1885/CodecBzip2.jl )
49
67
- [ CodecXz.jl] ( https://github.com/bicycle1885/CodecXz.jl )
0 commit comments