Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
treeform committed Jun 20, 2022
1 parent bbe6448 commit 3eb234c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Zippy

![Github Actions](https://github.com/guzba/zippy/workflows/Github%20Actions/badge.svg)

`nimble install zippy`

![Github Actions](https://github.com/treeform/zippy/workflows/Github%20Actions/badge.svg)

[API reference](https://nimdocs.com/treeform/zippy)

This library has no dependencies other than the Nim standard library.

Zippy is an implementation of [DEFLATE](https://tools.ietf.org/html/rfc1951), [ZLIB](https://tools.ietf.org/html/rfc1950) and [GZIP](https://tools.ietf.org/html/rfc1952) data compression formats.

Zippy can also open [ZIP archives](https://en.wikipedia.org/wiki/Zip_(file_format)) (.zip) and [Tarballs](https://en.wikipedia.org/wiki/Tar_(computing)) (.tar, .tar.gz, .tgz, .taz).
Expand All @@ -14,10 +18,6 @@ To ensure Zippy is compatible with other implementations, `tests/validate.nim` c

This library works well using Nim's `--gc:arc` and `--gc:orc` as well as the default garbage collector. This library also works using both `nim c` and `nim cpp`, in addition to `--cc:vcc` on Windows.

## Documentation

https://nimdocs.com/guzba/zippy/zippy.html

## Examples

Simple examples using Zippy can be found in the [examples/](https://github.com/guzba/zippy/blob/master/examples) folder.
Expand Down

0 comments on commit 3eb234c

Please sign in to comment.