Merge pull request #149 from Kyle-Ye/optimize/doc

glessard · web-flow · commit 51f6be041ff9 · 2024-02-02T15:56:58.000-08:00
Enable Swift Package Index documentation and add API doc link
diff --git a/.spi.yml b/.spi.yml
@@ -0,0 +1,4 @@
+version: 1
+builder:
+  configs:
+    - documentation_targets: [SystemPackage]
diff --git a/README.md b/README.md
@@ -22,6 +22,8 @@ try fd.closeAfter {
 }
 ```
 
+[API documentation](https://swiftpackageindex.com/apple/swift-system/main/documentation/SystemPackage)
+
 ## Adding `SystemPackage` as a Dependency
 
 To use the `SystemPackage` library in a SwiftPM project,

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@ try fd.closeAfter {`
`22`	`22`	`}`
`23`	`23`	```
`24`	`24`
	`25`	`+[API documentation](https://swiftpackageindex.com/apple/swift-system/main/documentation/SystemPackage)`
	`26`	`+`
`25`	`27`	## Adding `SystemPackage` as a Dependency
`26`	`28`
`27`	`29`	To use the `SystemPackage` library in a SwiftPM project,