Skip to content

Commit a11fe7d

Browse files
authored
Update README.md
1 parent 4ba5edf commit a11fe7d

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,48 @@ Or install it yourself as:
3434
require 'zstd-ruby'
3535
```
3636

37-
### compression
37+
### Simple Compression
3838

3939
```ruby
4040
compressed_data = Zstd.compress(data)
4141
compressed_data = Zstd.compress(data, complession_level) # default compression_level is 0
4242
```
4343

44+
### Streaming Compression
45+
```
46+
stream = Zstd::StreamingCompress.new
47+
stream << "abc" << "def"
48+
res = stream.flush
49+
stream << "ghi"
50+
res << stream.finish
51+
```
52+
53+
or
54+
55+
```
56+
stream = Zstd::StreamingCompress.new
57+
res = stream.compress("abc")
58+
res << stream.flush
59+
res << stream.compress("def")
60+
res << stream.finish
61+
```
4462

45-
### decompression
63+
### Simple Decompression
4664

4765
```ruby
4866
data = Zstd.decompress(compressed_data)
4967
```
5068

69+
### Streaming Decompression
70+
```
71+
cstr = "" # Compressed data
72+
stream = Zstd::StreamingDecompress.new
73+
result = ''
74+
result << stream.decompress(cstr[0, 10])
75+
result << stream.decompress(cstr[10..-1])
76+
```
77+
78+
5179
## JRuby
5280
This gem does not support JRuby.
5381

0 commit comments

Comments
 (0)