Skip to content

Commit 5476190

Browse files
authored
chore: add support policy (#538)
1 parent fd4decf commit 5476190

File tree

1 file changed

+29
-16
lines changed

1 file changed

+29
-16
lines changed

README.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,17 @@ Supabase client for swift. Mirrors the design of [supabase-js](https://github.co
66

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

9-
## Supported Platforms
10-
11-
| Platform | Support |
12-
|--------|--------|
13-
| iOS ||
14-
| macOS ||
15-
| watchOS ||
16-
| tvOS ||
17-
| visionOS ||
18-
| Linux | ☑️ |
19-
| Windows | ☑️ |
20-
21-
> ✅ Official support
22-
>
23-
> ☑️ Works but not officially supported, and not guaranttee to keep working on future versions of the library.
24-
259
## Usage
2610

11+
### Requirements
12+
- iOS 13.0+ / macOS 10.15+ / tvOS 13+ / watchOS 6+ / visionOS 1+
13+
- Xcode 15.x
14+
- Swift 5.9+
15+
16+
> [!IMPORTANT]
17+
> Check the [Support Policy](#support-policy) to learn when dropping Xcode, Swift, and platform versions will not be considered a **breaking change**.
18+
19+
### Installation
2720
Install the library using the Swift Package Manager.
2821

2922
```swift
@@ -78,6 +71,26 @@ let client = SupabaseClient(
7871
)
7972
```
8073

74+
## Support Policy
75+
76+
This document outlines the scope of support for Xcode, Swift, and the various platforms (iOS, macOS, tvOS, watchOS, and visionOS) in Supabase.
77+
78+
### Xcode
79+
We only support Xcode versions that are currently eligible for submitting apps to the App Store. Once a specific version of Xcode is no longer supported, its removal from Supabase **won't be treated as a breaking change** and will occur in a minor release.
80+
81+
### Swift
82+
The minimum supported Swift version corresponds to the minor version released with the oldest-supported Xcode version. When a Swift version reaches its end of support, it will be dropped from Supabase in a **minor release**, and **this won't be considered a breaking change**.
83+
84+
### Platforms
85+
We maintain support for the four latest major versions of each platform, including the current version.
86+
87+
When a platform version is no longer supported, Supabase will drop it in a **minor release**, and **this won't count as a breaking change**. For instance, iOS 14 will no longer be supported after the release of iOS 18, allowing its removal in a minor update.
88+
89+
For macOS, the named yearly releases are treated as major versions for this policy, regardless of their version numbers.
90+
91+
> [!IMPORTANT]
92+
> Linux and Windows works but aren't supported, and may stop working on future versions of the library.
93+
8194
## Contributing
8295

8396
- Fork the repo on GitHub

0 commit comments

Comments
 (0)