From 92b6794acab95709aa76ebd6d236eb7d26671b80 Mon Sep 17 00:00:00 2001 From: Jordan Danford Date: Thu, 15 Feb 2024 10:44:19 -0700 Subject: [PATCH 1/3] Fix build status badge and other bits in README.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c927263..86ad7af 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ rust-rocksdb ============ +![RocksDB build](https://github.com/zaidoon1/rust-rocksdb/actions/workflows/rust.yml/badge.svg?branch=master) [![crates.io](https://img.shields.io/crates/v/rust-rocksdb.svg)](https://crates.io/crates/rust-rocksdb) [![documentation](https://docs.rs/rust-rocksdb/badge.svg)](https://docs.rs/rust-rocksdb) [![license](https://img.shields.io/crates/l/rust-rocksdb.svg)](https://github.com/zaidoon1/rust-rocksdb/blob/master/LICENSE) ![rust 1.75.0 required](https://img.shields.io/badge/rust-1.75.0-blue.svg?label=MSRV) +![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/zaidoon1/rust-rocksdb/latest.svg) + ## Why The Fork The original [rust-rocksdb repo](https://github.com/rust-rocksdb/rust-rocksdb) is amazing and I appreciate all the work that has @@ -20,7 +23,7 @@ control and be able to create regular releases. ## Contributing -Feedback and pull requests welcome! If a particular feature of RocksDB is +Feedback and pull requests welcome! If a particular feature of RocksDB is important to you, please let me know by opening an issue, and I'll prioritize it. @@ -30,19 +33,21 @@ This binding is statically linked with a specific version of RocksDB. If you want to build it yourself, make sure you've also cloned the RocksDB and compression submodules: - git submodule update --init --recursive +```shell +git submodule update --init --recursive +``` ## Compression Support By default, support for the [Snappy](https://github.com/google/snappy), [LZ4](https://github.com/lz4/lz4), [Zstd](https://github.com/facebook/zstd), [Zlib](https://zlib.net), and [Bzip2](http://www.bzip.org) compression -is enabled through crate features. If support for all of these compression +is enabled through crate features. If support for all of these compression algorithms is not needed, default features can be disabled and specific compression algorithms can be enabled. For example, to enable only LZ4 compression support, make these changes to your Cargo.toml: -``` +```toml [dependencies.rocksdb] default-features = false features = ["lz4"] @@ -53,6 +58,6 @@ features = ["lz4"] The underlying RocksDB does allow column families to be created and dropped from multiple threads concurrently. But this crate doesn't allow it by default for compatibility. If you need to modify column families concurrently, enable -crate feature called `multi-threaded-cf`, which makes this binding's -data structures to use RwLock by default. Alternatively, you can directly create +the crate feature `multi-threaded-cf`, which makes this binding's +data structures use `RwLock` by default. Alternatively, you can directly create `DBWithThreadMode` without enabling the crate feature. From 199b8b63cdf971cae60cae48e23a8a378552869b Mon Sep 17 00:00:00 2001 From: Jordan Danford Date: Thu, 15 Feb 2024 10:48:08 -0700 Subject: [PATCH 2/3] More README.md fixes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 86ad7af..da6f223 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ git submodule update --init --recursive ## Compression Support -By default, support for the [Snappy](https://github.com/google/snappy), +By default, support for [Snappy](https://github.com/google/snappy), [LZ4](https://github.com/lz4/lz4), [Zstd](https://github.com/facebook/zstd), [Zlib](https://zlib.net), and [Bzip2](http://www.bzip.org) compression is enabled through crate features. If support for all of these compression @@ -55,8 +55,8 @@ features = ["lz4"] ## Multithreaded ColumnFamily alternation -The underlying RocksDB does allow column families to be created and dropped -from multiple threads concurrently. But this crate doesn't allow it by default +RocksDB allows column families to be created and dropped +from multiple threads concurrently, but this crate doesn't allow it by default for compatibility. If you need to modify column families concurrently, enable the crate feature `multi-threaded-cf`, which makes this binding's data structures use `RwLock` by default. Alternatively, you can directly create From 0b77d108c7a92fb095c49c3485f9cc6a566fb383 Mon Sep 17 00:00:00 2001 From: Jordan Danford Date: Thu, 15 Feb 2024 10:52:42 -0700 Subject: [PATCH 3/3] Turn build status badge into link in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index da6f223..a264851 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ rust-rocksdb ============ -![RocksDB build](https://github.com/zaidoon1/rust-rocksdb/actions/workflows/rust.yml/badge.svg?branch=master) +[![RocksDB build](https://github.com/zaidoon1/rust-rocksdb/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/zaidoon1/rust-rocksdb/actions/workflows/rust.yml) [![crates.io](https://img.shields.io/crates/v/rust-rocksdb.svg)](https://crates.io/crates/rust-rocksdb) [![documentation](https://docs.rs/rust-rocksdb/badge.svg)](https://docs.rs/rust-rocksdb) [![license](https://img.shields.io/crates/l/rust-rocksdb.svg)](https://github.com/zaidoon1/rust-rocksdb/blob/master/LICENSE)