From ff990487512aa058fe80292dfbc440eac5a493aa Mon Sep 17 00:00:00 2001 From: Nyk Ma Date: Tue, 11 Oct 2022 15:40:36 +0800 Subject: [PATCH] [+] kv-service/use-cases --- docs/kv-service/intro.md | 12 ++++++++++-- docs/kv-service/use-cases.md | 19 +++++++++++++++++++ sidebars.js | 2 +- 3 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 docs/kv-service/use-cases.md diff --git a/docs/kv-service/intro.md b/docs/kv-service/intro.md index 56bff0b..0a12360 100644 --- a/docs/kv-service/intro.md +++ b/docs/kv-service/intro.md @@ -21,6 +21,15 @@ chain](/proof-service/glossary.md#glossary-proof-chain) to ensure: - Traceable: all changes are approved by user and cannot be falsified by third parties. +- Revertable: works like `git` patch set. + +:::caution WIP + +Reversion is not implemented for now, but [should be kinda easy to impl +](https://github.com/nextdotid/kv_server/issues/7). + +::: + - Decentralized: The user has the full right to dispose the data. :::caution WIP @@ -67,8 +76,7 @@ verify each changes, and restore the final data status. ## Use case -- Web3 apps need to save user configurations - > e.g. profile (name, avatar link, bio, etc.), NFT showcase (hide/show, order, etc.) or wallet address priority. +See [use cases](kv-use-cases). ## Workflow diff --git a/docs/kv-service/use-cases.md b/docs/kv-service/use-cases.md new file mode 100644 index 0000000..cbb1278 --- /dev/null +++ b/docs/kv-service/use-cases.md @@ -0,0 +1,19 @@ +--- +id: kv-use-cases +title: Use Cases +sidebar_position: 7 +--- + +KVService works as a general key-value store. It can be used in many different scenarios. This page lists some of the use cases. + +## KVService as a persistence storage + +You can use KVService to store the data that needs cross-session persistence. + +For example, you can store the user's avatar, nick name, bio, show/hide status of NFT list, or order of these contents, under your web3 app's scenarios. + +Using KVservices gives you some benefits: + +- The change made by user is verifiable by other user / applications, aka platform-independent. No one (except the user himself) can change the data without a valid signature. +- The data is stored in a decentralized way, no matter where this data is actually stored. User always has a choice to move their data to other (or self-hosted) platforms. + > The actual "migration" function is still under development. diff --git a/sidebars.js b/sidebars.js index bff15ac..b97e309 100644 --- a/sidebars.js +++ b/sidebars.js @@ -25,7 +25,7 @@ module.exports = { type: 'category', label: 'KVService', collapsed: true, - items: ['kv-service/kv-intro'] + items: ['kv-service/kv-intro', 'kv-service/kv-faq', 'kv-service/kv-use-cases', 'kv-service/kv-api'] }, { type: 'category', label: 'RelationService',