From 404d88564adbf4645512344d648d1533f992c828 Mon Sep 17 00:00:00 2001 From: Pierre Balzack <96387156+balzack@users.noreply.github.com> Date: Wed, 28 Aug 2024 08:10:09 -0700 Subject: [PATCH] Update README.md --- app/sdk/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/app/sdk/README.md b/app/sdk/README.md index a8b730ab..5b5cd595 100644 --- a/app/sdk/README.md +++ b/app/sdk/README.md @@ -8,6 +8,8 @@ The API is provided through a set of typescript interfaces. Each interface group
The SDK must first be allocated
+ +The crypto and log params are provided by implementing the [Crypto](https://github.com/balzack/databag/blob/sdk/app/sdk/src/crypto.ts) and [Logging](https://github.com/balzack/databag/blob/sdk/app/sdk/src/logging.ts) interface respectively. ```DatabacgClientSDK(crypto?: Crypto, log?: Logging)```
@@ -15,11 +17,11 @@ The API is provided through a set of typescript interfaces. Each interface group
Persistent storage can then be provided to the SDK
-Mobile apps typically use the SqlStore interface allowing for offline use cases where most of the relational data is stored +Mobile apps typically use the SqlStore interface allowing for offline use cases where most of the relational data is stored. The sql param for the offline store is provided by implementing the [SqlStore]([Crypto](https://github.com/balzack/databag/blob/sdk/app/sdk/src/store.ts) interface. ```initOfflineStore(sql: SqlStore): Promise``` -Browser apps typically use the WebStore interface where minimal session data is stored +Browser apps typically use the WebStore interface where minimal session data is stored. The web param for the minimal online store is provided by implementing the [WebStore]([Crypto](https://github.com/balzack/databag/blob/sdk/app/sdk/src/store.ts) interface. ```initOnlineStore(web: WebStore): Promise```