Skip to content

Commit ff99048

Browse files
committed
[+] kv-service/use-cases
1 parent 7dd8c18 commit ff99048

File tree

3 files changed

+30
-3
lines changed

3 files changed

+30
-3
lines changed

docs/kv-service/intro.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ chain](/proof-service/glossary.md#glossary-proof-chain) to ensure:
2121

2222
- Traceable: all changes are approved by user and cannot be falsified
2323
by third parties.
24+
- Revertable: works like `git` patch set.
25+
26+
:::caution WIP
27+
28+
Reversion is not implemented for now, but [should be kinda easy to impl
29+
](https://github.com/nextdotid/kv_server/issues/7).
30+
31+
:::
32+
2433
- Decentralized: The user has the full right to dispose the data.
2534

2635
:::caution WIP
@@ -67,8 +76,7 @@ verify each changes, and restore the final data status.
6776

6877
## Use case
6978

70-
- Web3 apps need to save user configurations
71-
> e.g. profile (name, avatar link, bio, etc.), NFT showcase (hide/show, order, etc.) or wallet address priority.
79+
See [use cases](kv-use-cases).
7280

7381
## Workflow
7482

docs/kv-service/use-cases.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
id: kv-use-cases
3+
title: Use Cases
4+
sidebar_position: 7
5+
---
6+
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.
8+
9+
## KVService as a persistence storage
10+
11+
You can use KVService to store the data that needs cross-session persistence.
12+
13+
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.
14+
15+
Using KVservices gives you some benefits:
16+
17+
- 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.
18+
- 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.
19+
> The actual "migration" function is still under development.

sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module.exports = {
2525
type: 'category',
2626
label: 'KVService',
2727
collapsed: true,
28-
items: ['kv-service/kv-intro']
28+
items: ['kv-service/kv-intro', 'kv-service/kv-faq', 'kv-service/kv-use-cases', 'kv-service/kv-api']
2929
}, {
3030
type: 'category',
3131
label: 'RelationService',

0 commit comments

Comments
 (0)