From 16dcb06f3607e02166cab5ea89399d77ca1c7b2b Mon Sep 17 00:00:00 2001 From: Yuan Chen Date: Thu, 18 Sep 2025 00:37:15 -0400 Subject: [PATCH] #86 update readme to reflect changes after the publish to Swift Package Index --- .spi.yml | 4 ++++ README.md | 8 ++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 .spi.yml diff --git a/.spi.yml b/.spi.yml new file mode 100644 index 0000000..b6443c7 --- /dev/null +++ b/.spi.yml @@ -0,0 +1,4 @@ +version: 1 +builder: + configs: + - documentation_targets: [arrow-swift] \ No newline at end of file diff --git a/README.md b/README.md index 327ea70..035fefb 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,13 @@ ## Install -TODO: We should update this after we register this package to Swift Package Index. +[![Swift Package Index](https://swiftpackageindex.com/apache/arrow-swift/badge.swift)](https://swiftpackageindex.com/apache/arrow-swift) + +You can add Apache Arrow Swift to your project using Swift Package Manager. For complete installation instructions and version selection, see the [Swift Package Index page](https://swiftpackageindex.com/apache/arrow-swift/). ## Getting Started -TODO: We should refer auto generated documentation on Swift Package Index after we register this package to Swift Package Index. +You can browse API documentation and usage examples at our [Swift Package Index documentation page](https://swiftpackageindex.com/apache/arrow-swift/documentation). Once added, import Arrow in your code and get started! ## Getting involved @@ -47,3 +49,5 @@ If you'd like to report a bug but don't have time to fix it, you can still post ## License [Apache 2.0](https://github.com/apache/arrow-swift/blob/main/LICENSE.txt) + +