Start updating README

Author: thecoolwinter

README.md

@@ -1,11 +1,26 @@
-# `supabase-swift`
+# supabase-swift
 
-Swift Client library to interact with Supabase.
+Supabase client for swift. Mirrors the design of [supabase-js](https://github.com/supabase/supabase-js/blob/master/README.md)
 
-- Documentation: https://supabase.io/docs/reference/swift/supabase-client
+## Installation
 
-## Sponsors
+Swift Package Manager:
 
-We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.
+Add the following lines to your `Package.swift` file:
+```swift
+let package = Package(
+    ...
+    dependencies: [
+        ...
+        .package(name: "Supabase", url: "https://github.com/supabase/supabase-swift.git", .branch("main")),
+    ],
+    targets: [
+        .target(
+            name: "YourTargetName",
+            dependencies: ["Supabase"] // Add as a dependency
+        )
+    ]
+)
+```
 
-[![New Sponsor](https://user-images.githubusercontent.com/10214025/90518111-e74bbb00-e198-11ea-8f88-c9e3c1aa4b5b.png)](https://github.com/sponsors/supabase)
+If you're using Xcode, [use this guide](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) to add `supabase-swift` to your project. Use `https://github.com/supabase/supabase-swift.git` for the url when Xcode asks.

Sources/Supabase/Supabase.swift

@@ -3,24 +3,38 @@ import PostgREST
 import Realtime
 import SupabaseStorage
 
-public class SupabaseClient {
-    var supabaseUrl: String
-    var supabaseKey: String
-    var schema: String
-    var restUrl: String
-    var realtimeUrl: String
-    var authUrl: String
-    var storageUrl: String
+/**
+ The main class for accessing Supabase functionality
+ 
+ Initialize this class using `.init(supabaseURL: String, supabaseKey: String)`
+ 
+ There are four main classes contained by the `Supabase` class.
+ 1.  `auth`
+ 2.  `database`
+ 3.  `realtime`
+ 4.  `storage`
+ Each class listed is available under `Supabase.{name}`, eg: `Supabase.auth`
+ */
+public class Supabase {
+    private var supabaseUrl: String
+    private var supabaseKey: String
+    private var schema: String
+    private var restUrl: String
+    private var realtimeUrl: String
+    private var authUrl: String
+    private var storageUrl: String
 
     public var auth: GoTrueClient
 
+    /// Storage client for Supabase.
     public var storage: SupabaseStorageClient {
         var headers: [String: String] = [:]
         headers["apikey"] = supabaseKey
         headers["Authorization"] = "Bearer \(auth.session?.accessToken ?? supabaseKey)"
         return SupabaseStorageClient(url: storageUrl, headers: headers)
     }
 
+    /// Database client for Supabase.
     public var database: PostgrestClient {
         var headers: [String: String] = [:]
         headers["apikey"] = supabaseKey
@@ -30,6 +44,12 @@ public class SupabaseClient {
 
     private var realtime: RealtimeClient
 
+    /// Init `Supabase` with the provided parameters.
+    /// - Parameters:
+    ///   - supabaseUrl: Unique Supabase project url
+    ///   - supabaseKey: Supabase anonymous API Key
+    ///   - schema: Database schema name, defaults to `public`
+    ///   - autoRefreshToken: Toggles whether `Supabase.auth` automatically refreshes the auth token. Defaults to `true`
     public init(
         supabaseUrl: String,
         supabaseKey: String,
@@ -52,3 +72,6 @@ public class SupabaseClient {
         realtime = RealtimeClient(endPoint: realtimeUrl, params: ["apikey": supabaseKey])
     }
 }
+
+@available(*, deprecated, message: "Use `Supabase` instead of `SupabaseClient`")
+typealias SupabaseClient = Supabase

Tests/SupabaseTests/SupabaseTests.swift

@@ -4,7 +4,7 @@ import XCTest
 @testable import Supabase
 
 final class SupabaseTests: XCTestCase {
-    var supabase = SupabaseClient(
+    var supabase = Supabase(
         supabaseUrl: SupabaseTests.supabaseUrl(), supabaseKey: SupabaseTests.supabaseKey())
 
     static func supabaseUrl() -> String {