README

spiraldb · Aug 12, 2024 · 5ff6cc6 · 5ff6cc6
1 parent 6acf4aa
commit 5ff6cc6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,12 @@
-# fsst
+# fsst-rs
+
+A pure-Rust, zero-dependency implementation of the [FSST string compression algorithm][whitepaper].
+
+FSST is a string compression algorithm meant for use in database systems. It was designed by
+[Peter Boncz, Thomas Neumann, and Viktor Leis][whitepaper]. It provides 1-3GB/sec compression
+and decompression of strings at compression rates competitive with or better than LZ4.
+
+**NOTE**: This  current implementation is still in-progress, please use at your own risk.
+
+
+[whitepaper]: https://www.vldb.org/pvldb/vol13/p2649-boncz.pdf
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,13 +1,4 @@
-//! A pure-Rust, zero-dependency implementation of the [FSST string compression algorithm][whitepaper].
-//!
-//! FSST is a string compression algorithm meant for use in database systems. It was designed by
-//! [Peter Boncz, Thomas Neumann, and Viktor Leis][whitepaper]. It provides 1-3GB/sec compression
-//! and decompression of strings at compression rates competitive with or better than LZ4.
-//!
-//! NOTE: This  current implementation is still in-progress, please use at your own risk.
-//!
-//! [whitepaper]: https://www.vldb.org/pvldb/vol13/p2649-boncz.pdf
-
+#![doc = include_str!("../README.md")]
 use std::fmt::{Debug, Formatter};
 
 pub use builder::*;