Skip to content

Commit fce0d22

Browse files
authored
README update with version stability (#15)
This PR updates the README with version stability explanation.
1 parent cfed222 commit fce0d22

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,20 @@ Or add it to your `Package.swift`:
3737

3838
```swift
3939
dependencies: [
40-
.package(url: "https://github.com/FlickerSoul/BinaryParseKit", branch: "main")
40+
.package(url: "https://github.com/FlickerSoul/BinaryParseKit", .upToNextMinor(from: "0.0.1"))
4141
]
4242
```
4343

44+
## Version Stability
45+
46+
Because the `BinaryParseKit` library is under active development, source-stability is only guaranteed within minor versions (e.g. between 0.0.3 and 0.0.4). If you don't want potentially source-breaking package updates, you can specify your package dependency using `.upToNextMinor(from: "0.0.1")` instead.
47+
48+
Future minor versions of the package may introduce changes to these rules as needed.
49+
50+
We want this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate. Accordingly, from time to time, we expect that new versions of this package will require clients to upgrade to a more recent Swift toolchain release. Requiring a new Swift release will only require a minor version bump.
51+
52+
When the package reaches a 1.0.0 release, the public API will consist of non-underscored declarations that are marked public in the `BinaryParseKit` module. Interfaces that aren't part of the public API may continue to change in any release, including the package’s examples, tests, utilities, and documentation.
53+
4454
## Quick Example
4555

4656
Consider a binary packet with the following structure:

0 commit comments

Comments
 (0)