Skip to content

Commit d654444

Browse files
authored
Revise README with project overview and roadmap
Updated README to provide project details and future plans.
1 parent edd8e07 commit d654444

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1-
A work-in-progress implementation of zstd to rust.
1+
# libzstd-rs-sys
22

3-
Absolutely not ready for use.
3+
This repository contains a Rust implementation of the zstd file format. It aims to provide excellent performance while introducing memory safety.
4+
5+
## How to use
6+
7+
libzstd-rs-sys is in development and is not yet ready for use.
8+
9+
We will release the decoder in early 2026 and the encoder (pending funding) later in the year.
10+
11+
## Performance
12+
13+
We track our performance at https://trifectatechfoundation.github.io/libzstd-rs-sys-bench/.
14+
15+
## Acknowledgments
16+
17+
This project is based on the [Zstandard reference implementation](https://github.com/facebook/zstd).
18+
19+
## About
20+
21+
libzstd-rs-sys is part of Trifecta Tech Foundation's [Data compression initiative](https://trifectatech.org/initiatives/data-compression/).

0 commit comments

Comments
 (0)