From 666ad766f4b7400c1e0645a302f39c88bef268cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E7=82=8E=E6=B3=BC?= Date: Tue, 28 Jun 2022 14:47:21 +0800 Subject: [PATCH] WIP: readme: remove status and roadmap, fold synopsis --- README.md | 41 +++++++++++----------------------------- docs/README.md.j2 | 31 ++++++++---------------------- scripts/requirements.txt | 6 +++--- 3 files changed, 22 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 4c5fa45a..f409b1d6 100644 --- a/README.md +++ b/README.md @@ -24,17 +24,12 @@ corresponding serialization APIs to persisting them on-disk or for transport. - [Why slim](#why-slim) - [Memory overhead](#memory-overhead) -- [Performance](#performance) -- [False Positive Rate](#false-positive-rate) -- [Status](#status) -- [Roadmap](#roadmap) -- [Change-log](#change-log) +- [Performance benchmark](#performance-benchmark) - [Synopsis](#synopsis) - - [Index keys, get by key](#index-keys-get-by-key) - - [Index key ranges, get by key](#index-key-ranges-get-by-key) - - [Scan](#scan) + - [Use SlimIndex to index external data](#use-slimindex-to-index-external-data) - [Getting started](#getting-started) - [Who are using slim](#who-are-using-slim) +- [Roadmap](#roadmap) - [Feedback and contributions](#feedback-and-contributions) - [Authors](#authors) - [License](#license) @@ -146,34 +141,19 @@ Time(in nano second) spent on a `Get()` with different key count(`n`) and key le See: [trie/report/](trie/report/) -## Status - -- `SlimTrie` APIs are stable, and has been used in a production env. - - Meanwhile we focus on optimizing memory usage and query performance. - -- Internal data structure are promised to be backward compatible for ever. - No data migration issue! - - -## Roadmap - -- [x] **2021-01-15** v0.5.11 Query by range -- [x] **2019-09-18** v0.5.10 Reduce false positive rate to less than 0.05% -- [x] **2019-06-03** v0.5.9 Large key set benchmark -- [x] **2019-05-29** v0.5.6 Support up to 2 billion keys -- [x] **2019-05-18** v0.5.4 Reduce memory usage from 40 to 14 bits/key -- [x] **2019-04-20** v0.4.3 Range index: many keys share one index item -- [x] **2019-04-18** v0.4.1 Marshaling support -- [x] **2019-03-08** v0.1.0 SlimIndex SlimTrie - ## Change-log [Change-log](docs/change-log.yaml) ## Synopsis -### Index keys, get by key +### Index key-value records, Fetch by key + +One of the typical usages of slim is to index serialized data on disk(e.g., key value records in a SSTable). +By keeping a slim in memory, one can quickly find the on-disk offset of the record by a key. + +
+ Show me the code ```go package index_test @@ -240,6 +220,7 @@ func Example() { // value: "" } ``` +
### Index key ranges, get by key diff --git a/docs/README.md.j2 b/docs/README.md.j2 index 551f45f4..81bbd67b 100644 --- a/docs/README.md.j2 +++ b/docs/README.md.j2 @@ -17,7 +17,6 @@ corresponding serialization APIs to persisting them on-disk or for transport. - [Why slim](#why-slim) - [Memory overhead](#memory-overhead) - [Performance benchmark](#performance-benchmark) -- [Status](#status) - [Synopsis](#synopsis) - [Use SlimIndex to index external data](#use-slimindex-to-index-external-data) - [Getting started](#getting-started) @@ -134,38 +133,24 @@ Time(in nano second) spent on a `Get()` with different key count(`n`) and key le See: [trie/report/](trie/report/) -## Status - -- `SlimTrie` APIs are stable, and has been used in a production env. - - Meanwhile we focus on optimizing memory usage and query performance. - -- Internal data structure are promised to be backward compatible for ever. - No data migration issue! - - -## Roadmap - -- [x] **2021-01-15** v0.5.11 Query by range -- [x] **2019-09-18** v0.5.10 Reduce false positive rate to less than 0.05% -- [x] **2019-06-03** v0.5.9 Large key set benchmark -- [x] **2019-05-29** v0.5.6 Support up to 2 billion keys -- [x] **2019-05-18** v0.5.4 Reduce memory usage from 40 to 14 bits/key -- [x] **2019-04-20** v0.4.3 Range index: many keys share one index item -- [x] **2019-04-18** v0.4.1 Marshaling support -- [x] **2019-03-08** v0.1.0 SlimIndex SlimTrie - ## Change-log [Change-log](docs/change-log.yaml) ## Synopsis -### Index keys, get by key +### Index key-value records, Fetch by key + +One of the typical usages of slim is to index serialized data on disk(e.g., key value records in a SSTable). +By keeping a slim in memory, one can quickly find the on-disk offset of the record by a key. + +
+ Show me the code ```go {% include 'index/example_test.go' %} ``` +
### Index key ranges, get by key diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 0fabbf3d..09ea8817 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1,3 +1,3 @@ -semantic_version~=2.6.0 -jinja2~=2.11.0 -PyYAML~=5.4.0 +semantic_version>=2.6.0 +jinja2>=2.11.0 +PyYAML>=5.3.0