Skip to content

Commit 820ef9e

Browse files
committed
docs: update README to include new libs of this package
1 parent 3bdb3e7 commit 820ef9e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
# SwiftTTSCombine
1+
# SwiftTTS
22

3-
A very straightforward Combine wrapper around TTS part of AVFoundation/AVSpeechSynthesizer to allow you using Text to Speech with ease.
3+
This package contains some very straightforward wrappers around TTS part of AVFoundation/AVSpeechSynthesizer to allow you using Text to Speech with ease.
44

5-
## Usage
5+
* `SwiftTTS` Using **Swift Concurrency** with `async` `await`, a couple of `AsyncStream`
6+
* `SwiftTTSDependency` A wrapper around the library above facilitating the integration with [Point-Free Dependencies](https://github.com/pointfreeco/swift-dependencies) library or a project made with The Composable Architecture (TCA).
7+
* `SwiftTTSCombine` the OG library still available in this package
8+
9+
## Modern concurrency usage
10+
11+
🔨 TODO
12+
13+
## [Point-Free Dependencies](https://github.com/pointfreeco/swift-dependencies) usage
14+
15+
🔨 TODO
16+
17+
## Combine Usage
618

719
You can instantiate/inject `TTSEngine` object, it has this behavior
820

@@ -47,7 +59,7 @@ engine.speak(string: "Hello World! But slower")
4759
You can add SwiftTTSCombine to an Xcode project by adding it as a package dependency.
4860

4961
1. From the **File** menu, select **Swift Packages › Add Package Dependency...**
50-
2. Enter "https://github.com/renaudjenny/SwiftTTSCombine" into the package repository URL test field
62+
2. Enter "https://github.com/renaudjenny/SwiftTTS" into the package repository URL test field
5163

5264
### As package dependency
5365

@@ -57,13 +69,15 @@ Edit your `Package.swift` to add this library.
5769
let package = Package(
5870
...
5971
dependencies: [
60-
.package(url: "https://github.com/renaudjenny/SwiftTTSCombine", from: "1.0.0"),
72+
.package(url: "https://github.com/renaudjenny/SwiftTTS", from: "2.0.0"),
6173
...
6274
],
6375
targets: [
6476
.target(
6577
name: "<Your project name>",
66-
dependencies: ["SwiftTTSCombine"]),
78+
dependencies: ["SwiftTTS"]), // <-- Modern concurrency
79+
dependencies: ["SwiftTTSDependency"]), // <-- Point-Free Dependencies library wrapper
80+
dependencies: ["SwiftTTSCombine"]), // <-- Combine wrapper
6781
...
6882
]
6983
)

0 commit comments

Comments
 (0)