Improved documentation

This commit is contained in:
Eduard Urbach 2023-07-06 15:12:29 +02:00
parent 780551c206
commit 1703dcb60d
Signed by: akyoto
GPG Key ID: C874F672B1AF20C0

View File

@ -4,8 +4,6 @@ In-memory key value store that saves your data to plain old JSON files.
If you like, you can operate on your entire data with classic UNIX tools.
Suitable for small to medium data volume.
## Installation
```shell
@ -38,3 +36,9 @@ users := ocean.New[User]("google")
```
You can add as many directory hierarchies as you need but I recommend using a simple `/namespace/collection/` structure.
## Limitations
This storage mechanism is suitable for small to medium data volume.
It is not suited for big data, however the package is pretty lightweight so you can combine it with a big data store.