Skip to content

Commit fffb1e4

Browse files
Add “Using in your project” section to readme
1 parent 5afdac0 commit fffb1e4

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# Swift Scoped File Path
22

33
A Swift package introducing separate `AbsoluteFilePath` and `RelativeFilePath` based on `FilePath` from [Swift System](https://github.com/apple/swift-system).
4+
5+
## Using Swift Scoped File Path in your project
6+
7+
Add `swift-scoped-file-path` as a dependency to your package:
8+
9+
```swift
10+
let package = Package(
11+
// ...
12+
dependencies: [
13+
.package(url: "https://github.com/Formkunft/swift-scoped-file-path", .upToNextMajor(from: "0.2.0")),
14+
],
15+
targets: [
16+
.target(
17+
// ...
18+
dependencies: [
19+
.product(name: "ScopedFilePath", package: "swift-scoped-file-path"),
20+
]),
21+
]
22+
)
23+
```
24+
25+
Then, import `ScopedFilePath` in your code:
26+
27+
```swift
28+
import ScopedFilePath
29+
30+
// ...
31+
```

0 commit comments

Comments
 (0)