mirror of
https://github.com/vlang/v.git
synced 2023-08-10 21:13:21 +03:00
docs: adding skeleton README.md files for all vlib modules (#13034)
This commit is contained in:
4
vlib/compress/README.md
Normal file
4
vlib/compress/README.md
Normal file
@ -0,0 +1,4 @@
|
||||
## Description:
|
||||
|
||||
`compress` is a namespace for (multiple) compression algorithms supported by V.
|
||||
At the moment, only `compress.zlib` is implemented.
|
16
vlib/compress/zlib/README.md
Normal file
16
vlib/compress/zlib/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
## Description:
|
||||
|
||||
`compress.zlib` implements zlib compression and decompression of binary data.
|
||||
|
||||
## Examples:
|
||||
|
||||
```v
|
||||
import compress.zlib
|
||||
|
||||
fn main() {
|
||||
uncompressed := 'Hello world!'
|
||||
compressed := zlib.compress(uncompressed.bytes()) ?
|
||||
decompressed := zlib.decompress(compressed) ?
|
||||
assert decompressed == uncompressed.bytes()
|
||||
}
|
||||
```
|
Reference in New Issue
Block a user