chore: Use Swift Package Index for how to install and documentation #87
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| version: 1 | ||
| builder: | ||
| configs: | ||
| - documentation_targets: [arrow-swift] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,11 +23,13 @@ | |
|
|
||
| ## Install | ||
|
|
||
| [](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/). | ||
|
There was a problem hiding this comment. It seems that https://swiftpackageindex.com/apache/arrow-swift/ doesn't include "complete installation instructions". Should we write them by ourselves? There was a problem hiding this comment. these will be generated as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation |
||
|
|
||
| ## Getting Started | ||
|
|
||
| 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! | ||
|
There was a problem hiding this comment. It seems that https://swiftpackageindex.com/apache/arrow-swift/documentation doesn't exist. Could you check it? There was a problem hiding this comment. these will be generated as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation |
||
|
|
||
| ## 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) | ||
|
|
||
|
|
||
|
Comment on lines
+52
to
+53
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that this badge URL is 404: https://swiftpackageindex.com/apache/arrow-swift/badge.swift
Could you check it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these will be generated as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation