Update documentation

al8n · Sep 14, 2024 · 5baaef8 · 5baaef8
1 parent c427295
commit 5baaef8
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,5 @@
-# UNRELEASED
+# 0.1.0 (Sep 14th, 2024)
 
-# 0.1.2 (January 6th, 2022)
+- Publish version `0.1.0`
 
 FEATURES
-
-
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,13 +1,15 @@
 [package]
 name = "orderwal"
-version = "0.0.0"
+version = "0.1.0"
 edition = "2021"
 repository = "https://github.com/al8n/orderwal"
 homepage = "https://github.com/al8n/orderwal"
 documentation = "https://docs.rs/orderwal"
-description = "An ordered Write-Ahead Log implementation for Rust."
+description = "A generic-purpose, ordered, zero-copy, Write-Ahead Log implementation for Rust."
 license = "MIT OR Apache-2.0"
 rust-version = "1.80"
+categories = ["filesystem", "database-implementations", "development-tools", "data-structures"]
+keywords = ["wal", "write-ahead-log", "append-only", "append-only-log", "bitcask"]
 
 [[bench]]
 path = "benches/foo.rs"

diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -1,9 +1,9 @@
 <div align="center">
-<h1>orderwal</h1>
+<h1>OrderWAL</h1>
 </div>
 <div align="center">
 
-开源Rust代码库GitHub模版
+An ordered, zero-copy, Write-Ahead Log implementation for Rust.
 
 [<img alt="github" src="https://img.shields.io/badge/github-al8n/orderwal-8da0cb?style=for-the-badge&logo=Github" height="22">][Github-url]
 <img alt="LoC" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Fal8n%2F327b2a8aef9003246e45c6e47fe63937%2Fraw%2Forderwal" height="22">
@@ -23,13 +23,9 @@
 
 ```toml
 [dependencies]
-template_rs = "0.1"
+orderwal = "0.1"
 ```
 
-## Features
-
-- [x] 更快的创建GitHub开源Rust代码库
-
 #### License
 
 `orderwal` is under the terms of both the MIT license and the

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 <div align="center">
-<h1>orderwal</h1>
+<h1>OrderWAL</h1>
 </div>
 <div align="center">
 
-A template for creating Rust open-source GitHub repo.
+A generic-purpose, ordered, zero-copy, Write-Ahead Log implementation for Rust.
 
 [<img alt="github" src="https://img.shields.io/badge/github-al8n/orderwal-8da0cb?style=for-the-badge&logo=Github" height="22">][Github-url]
 <img alt="LoC" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Fal8n%2F327b2a8aef9003246e45c6e47fe63937%2Fraw%2Forderwal" height="22">
@@ -19,15 +19,23 @@ English | [简体中文][zh-cn-url]
 
 </div>
 
+## Introduction
+
+`orderwal` is a generic-purpose, ordered, zero-copy, concurrent-safe, pre-allocate style (memory map) write-ahead-log for developing databases.
+
+`orderwal` also supports generic structured key and value types, which is not limited to just bytes like other implementations.
+
 ## Installation
 
 ```toml
 [dependencies]
-template_rs = "0.1"
+orderwal = "0.1"
 ```
 
-## Features
-- [x] Create a Rust open-source repo fast 
+## Related projects
+
+- [`aol`](https://github.com/al8n/aol): Yet another generic purpose, append-only write-ahead log implementation based on `std::fs::File`.
+- [`skl`](https://github.com/al8n/skl): A lock-free, ARNEA based skiplist implementation, which supports in-memory and on-disk, suitable for frozen durable data file or memtable for LSM database.
 
 #### License