From 5e4190fd11f8c5213d011297cc34efc01f2bcc95 Mon Sep 17 00:00:00 2001
From: Tim Shedor <tshedor@gmail.com>
Date: Sat, 24 Aug 2024 16:13:32 -0700
Subject: [PATCH] update repository readme

---
 .../README.md                                 | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/packages/brick_offline_first_with_supabase/README.md b/packages/brick_offline_first_with_supabase/README.md
index 626ad5ce..788fe7fe 100644
--- a/packages/brick_offline_first_with_supabase/README.md
+++ b/packages/brick_offline_first_with_supabase/README.md
@@ -4,6 +4,62 @@
 
 The `OfflineFirstWithSupabase` domain uses all the same configurations and annotations as `OfflineFirst`.
 
+## Repository
+
+Adding offline support to Supabase is slightly more complicated than the average [../brick_offline_first_with_rest/README.md](repository process). Feedback is welcome on a smoother and more intuitive integration.
+
+````dart
+class MyRepository extends OfflineFirstWithSupabaseRepository {
+  static late MyRepository? _singleton;
+
+  MyRepository._({
+    required super.supabaseProvider,
+    required super.sqliteProvider,
+    required super.migrations,
+    required super.offlineRequestQueue,
+    super.memoryCacheProvider,
+  });
+
+  factory MyRepository() => _singleton!;
+
+  static void configure({
+    required String supabaseUrl,
+    required String apiKey,
+    required Set<Migration> migrations,
+  }) {
+    // Convenience method `.clientQueue` makes creating the queue and client easy.
+    final (client, queue) = OfflineFirstWithSupabaseRepository.clientQueue(
+      databaseFactory: databaseFactory,
+    );
+
+    final provider = SupabaseProvider(
+      // It's important to pass the offline client to your Supabase#Client instantiation.
+      // If you're using supabase_flutter, make sure you initialize with the clientQueue's client
+      // before passing it here. For example:
+      // ```dart
+      // await Supabase.initialize(httpClient: client)
+      // SupabaseProvider(Supabase.instance.client, modelDictionary: ...)
+      // ```
+      SupabaseClient(supabaseUrl, apiKey, httpClient: client),
+      modelDictionary: supabaseModelDictionary,
+    );
+
+    // Finally, initialize the repository as normal.
+    _singleton = MyRepository._(
+      supabaseProvider: provider,
+      sqliteProvider: SqliteProvider(
+        'my_repository.sqlite',
+        databaseFactory: databaseFactory,
+        modelDictionary: sqliteModelDictionary,
+      ),
+      migrations: migrations,
+      offlineRequestQueue: queue,
+      memoryCacheProvider: MemoryCacheProvider(),
+    );
+  }
+}
+````
+
 ## Models
 
 ### ConnectOfflineFirstWithSupabase