Skip to content

Commit

Permalink
Add WIP warning to README
Browse files Browse the repository at this point in the history
  • Loading branch information
grdsdev authored Nov 9, 2023
1 parent 71fd6bc commit efd5e3e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Supabase client for swift. Mirrors the design of [supabase-js](https://github.co

* Documentation: [https://supabase.com/docs/reference/swift/introduction](https://supabase.com/docs/reference/swift/introduction)

> [!WARNING]
> This library is a work in progress, you can choose to use the last available version 0.3.0, or use the `main` branch that contains the next 1.0 release.
> 1.0 will have several breacking changes, so I don't recommend you start a project using 0.3, just use the `main` branch from now, as the API is pretty much stable at this stage.
## Usage

Expand All @@ -16,7 +19,7 @@ let package = Package(
...
dependencies: [
...
.package(name: "Supabase", url: "https://github.com/supabase-community/supabase-swift.git", from: "1.0.0"), // Add the package
.package(name: "Supabase", url: "https://github.com/supabase-community/supabase-swift.git", branch: "main"), // Add the package
],
targets: [
.target(
Expand Down

0 comments on commit efd5e3e

Please sign in to comment.