Skip to content

Commit 1747852

Browse files
Carthage: add deprecation notice to README
1 parent 79e7522 commit 1747852

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

cartspec/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
ObjectBox Carthage Binary Project Specification
2-
===============================================
1+
# ObjectBox Carthage Binary Project Specification
2+
33
This folder contains [ObjectBox.json](ObjectBox.json), a [Chartage "index" for binary frameworks](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#binary-project-specification).
44
The advantage of using binary distribution is that those are slimmer than the "github" definition.
55
Using "binary" instead, never causes Carthage to check out the Git repository.
66
Thus updates are faster and less disk space is used.
77

8-
Add binary ObjectBox dependency
9-
-------------------------------
8+
## Add binary ObjectBox dependency
9+
10+
> [!WARNING]
11+
> The Carthage release is deprecated. See the root [README](/README.md) for more details.
12+
1013
In your Cartfile, you typically add a line like this:
1114

1215
binary "https://raw.githubusercontent.com/objectbox/objectbox-swift/master/cartspec/ObjectBox.json"
1316

14-
For details and up-to-date information, please consult the [installation docs](https://swift.objectbox.io/install).
17+
For details and up-to-date information, please consult the [installation docs](https://swift.objectbox.io/install).

0 commit comments

Comments
 (0)