Skip to content
This repository was archived by the owner on Sep 15, 2025. It is now read-only.

Commit 44eacfb

Browse files
committed
Update README with XCFramework deployment instructions
1 parent 644bbf6 commit 44eacfb

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# WordPressKit for iOS
22

3+
<!-- red -->
4+
> [!CAUTION]
5+
> This library is no longer fit for external contribution and community usage.
6+
>
7+
> [WordPress iOS](https://github.com/wordpress-mobile/WordPress-iOS) is its only consumer.
8+
> The repo exists standalone rather than as part of the WordPress codebase because it's convenient to fetch this lump of code that rarely changes as a binary XCFramework dependency.
9+
> See [#816](https://github.com/wordpress-mobile/WordPressKit-iOS/pull/816).
10+
11+
## XCFramework release instructions
12+
13+
- Run `.buildkite/create-xcframeworks.sh` to create binaries
14+
- Upload `.build/xcframeworks/WordPressKit.zip` to this repo
15+
- Update binary target in `Package.swift` with a new URL and checksum<sup>*</sup>
16+
- Push the new changes to your branch
17+
- After testing is done, merge changes into `trunk`
18+
19+
<sup>*</sup>_checksum is echoed at the end of the `create-xcframeworks.sh` script_
20+
321
## About
422

523
WordPressKit offers a clean and simple WordPress.com and WordPress.org API.

0 commit comments

Comments
 (0)