Skip to content

Commit

Permalink
Refine documentation and update to 1.0 releases (#4)
Browse files Browse the repository at this point in the history
# Refine documentation and update to 1.0 releases

## ♻️ Current situation & Problem
This PR slightly refines documentation and updates to the latest 1.0
Spezi framework releases.


## ⚙️ Release Notes 
* Refine documentation
* Update to 1.0 releases



## 📝 Code of Conduct & Contributing Guidelines 

By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md):
- [x] I agree to follow the [Code of
Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
  • Loading branch information
Supereg authored Jan 10, 2024
1 parent 8ccc0c0 commit a1e1d02
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ let package = Package(
.library(name: "SpeziSpeechSynthesizer", targets: ["SpeziSpeechSynthesizer"])
],
dependencies: [
.package(url: "https://github.com/StanfordSpezi/Spezi", .upToNextMinor(from: "0.8.0"))
.package(url: "https://github.com/StanfordSpezi/Spezi", from: "1.0.0")
],
targets: [
.target(
Expand Down
5 changes: 4 additions & 1 deletion Sources/SpeziSpeechRecognizer/SpeechRecognizer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ import os
import Speech
import Spezi

/// The Spezi ``SpeechRecognizer`` encapsulates the functionality of Apple's `Speech` framework, more specifically, the `SFSpeechRecognizer`.

/// Initiate and manage speech recognition.
///
/// The Spezi `SpeechRecognizer` encapsulates the functionality of Apple's `Speech` framework, more specifically, the `SFSpeechRecognizer`.
/// It provides methods to start and stop voice recognition and publishes the state of recognition and its availability.
///
/// > Important: If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) to set up the core Spezi infrastructure.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Provides speech-to-text capabilities via Apple's `Speech` framework.

## Overview

The Spezi ``SpeechRecognizer` encapsulates the functionality of Apple's `Speech` framework, more specifically, the `SFSpeechRecognizer`.
The Spezi ``SpeechRecognizer`` encapsulates the functionality of Apple's `Speech` framework, more specifically, the `SFSpeechRecognizer`.
It provides methods to start and stop voice recognition and publishes the state of recognition and its availability.

## Setup
Expand Down
5 changes: 4 additions & 1 deletion Sources/SpeziSpeechSynthesizer/SpeechSynthesizer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ import AVFoundation
import Observation
import Spezi

/// The Spezi ``SpeechSynthesizer`` encapsulates the functionality of Apple's `AVFoundation` framework, more specifically, the `AVSpeechSynthesizer`.

/// Produces synthesized speech from text utterances.
///
/// The Spezi `SpeechSynthesizer` encapsulates the functionality of Apple's `AVFoundation` framework, more specifically, the `AVSpeechSynthesizer`.
/// It provides methods to start and stop voice synthesizing and publishes the state of the process.
///
/// > Important: If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) to set up the core Spezi infrastructure.
Expand Down

0 comments on commit a1e1d02

Please sign in to comment.