diff --git a/CHANGELOG.md b/CHANGELOG.md index 9f8df24..4527b54 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,10 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com --> ## [Unreleased] +## [1.0.2] - 2024-08-13 + +- doc + ## [1.0.1] - 2024-08-13 - update keyring to 3.0, removing linux only features diff --git a/Cargo.toml b/Cargo.toml index 292905a..72d072e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ members = ["encrypt-config", "encrypt-config-derive", "tests", "examples"] resolver = "2" [workspace.package] -version = "1.0.1" +version = "1.0.2" authors = ["Louis <836250617@qq.com>"] description = "A Rust crate to manage, persist and encrypt your configurations." license = "MIT" diff --git a/encrypt-config/README.md b/encrypt-config/README.md index e2dd0bc..46659f1 100644 --- a/encrypt-config/README.md +++ b/encrypt-config/README.md @@ -68,10 +68,6 @@ encrypt_config = { version = "1.0.0", features = ["full"] } opt-level = 3 ``` -**Caution: This version bases on `rom_cache` crate, and the cache size is fixed for easy using.** - -**So, too heavy workload will certainly lead to panic. See [`Config`] for detailes.** - ## About The Project @@ -102,8 +98,6 @@ The `Config` in this crate is a wrapper of `rom_cache::Cache`, only if the confi
- - ### Built With * Rust diff --git a/encrypt-config/src/config.rs b/encrypt-config/src/config.rs index bd4135c..98d9a73 100644 --- a/encrypt-config/src/config.rs +++ b/encrypt-config/src/config.rs @@ -10,8 +10,7 @@ use std::any::Any; /// 2. If cache miss, reading loads the value from the source to cache, while writing saves the value to source then loads it to cache. /// 3. All caches values dirty will be written back when Config dropped. /// -/// **At most N** different types in all threads are safe to be managed -/// due to the default cache capacity. +/// **At most N** different types in all threads are safe to be managed due to the default cache capacity. /// And each type can be ref **up to 63** times or mut ref **up to 1** time at the same time. /// Or panic occurs with errors like `Busy` or `Locked`. /// @@ -70,8 +69,6 @@ impl