Add citation and Swift Package index (#3)

# Add citation and SPM index ## ♻️ Current situation & Problem As we didn't tag a first release yet, the repo wasn't indexed by the Swift Package Index as well as Zendoo. ## ⚙️ Release Notes - Add citation and Swift Package index ## 📚 Documentation -- ## ✅ Testing -- ## 📝 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). --------- Co-authored-by: Paul Schmiedmayer <[email protected]>
StanfordSpezi · Nov 20, 2023 · 8ccc0c0 · 8ccc0c0
1 parent f629d66
commit 8ccc0c0
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 17 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -19,4 +19,5 @@ authors:
   given-names: "Rao"
   orcid: "https://orcid.org/0000-0002-0780-033X"
 title: "SpeziSpeech"
+doi: 10.5281/zenodo.10146086
 url: "https://github.com/StanfordSpezi/SpeziSpeech"
diff --git a/README.md b/README.md
@@ -12,7 +12,9 @@ SPDX-License-Identifier: MIT
 
 [![Build and Test](https://github.com/StanfordSpezi/SpeziSpeech/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/StanfordSpezi/SpeziSpeech/actions/workflows/build-and-test.yml)
 [![codecov](https://codecov.io/gh/StanfordSpezi/SpeziSpeech/graph/badge.svg?token=ufmRQvE0Cs)](https://codecov.io/gh/StanfordSpezi/SpeziSpeech)
-
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10146086.svg)](https://doi.org/10.5281/zenodo.10146086)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziSpeech%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/StanfordSpezi/SpeziSpeech)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziSpeech%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/StanfordSpezi/SpeziSpeech)
 
 Recognize and synthesize natural language speech.
 
@@ -32,11 +34,11 @@ You need to add the Spezi Speech Swift package to
 [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).
 
 > [!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 setup the core Spezi infrastructure.
+> 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.
 
 ### 2. Configure the `SpeechRecognizer` and the `SpeechSynthesizer` in the Spezi `Configuration`
 
-The [`SpeechRecognizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeech/speechrecognizer) and [`SpeechSynthesizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeech/speechsynthesizer) modules need to be registered in a Spezi-based application using the [`configuration`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate/configuration)
+The [`SpeechRecognizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeechrecognizer/speechrecognizer) and [`SpeechSynthesizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeechsynthesizer/speechsynthesizer) modules need to be registered in a Spezi-based application using the [`configuration`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate/configuration)
 in a [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate):
 ```swift
 class ExampleAppDelegate: SpeziAppDelegate {
@@ -66,8 +68,8 @@ These entries are mandatory for apps that utilize microphone and speech recognit
 
 ## Example
 
-`SpeechTestView` provides a demonstration of the capabilities of the Spezi Speech module.
-It showcases the interaction with the [`SpeechRecognizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeech/speechrecognizer) to provide speech-to-text capabilities and the [`SpeechSynthesizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeech/speechsynthesizer) to generate speech from text.
+`SpeechTestView` provides a demonstration of the capabilities of Spezi Speech.
+It showcases the interaction with the [`SpeechRecognizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeechrecognizer/speechrecognizer) to provide speech-to-text capabilities and the [`SpeechSynthesizer`](https://swiftpackageindex.com/stanfordspezi/spezispeech/documentation/spezispeechsynthesizer/speechsynthesizer) to generate speech from text.
 
 
 ```swift

diff --git a/Sources/SpeziSpeechRecognizer/SpeechRecognizer.swift b/Sources/SpeziSpeechRecognizer/SpeechRecognizer.swift
@@ -11,10 +11,10 @@ import os
 import Speech
 import Spezi
 
-/// 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.
+/// 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) setup the core Spezi infrastructure.
+/// > 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.
 ///
 /// The module needs to be registered in a Spezi-based application using the [`configuration`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate/configuration)
 /// in a [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate):

diff --git a/Sources/SpeziSpeechRecognizer/SpeziSpeechRecognizer.docc/SpeziSpeechRecognizer.md b/Sources/SpeziSpeechRecognizer/SpeziSpeechRecognizer.docc/SpeziSpeechRecognizer.md
@@ -14,8 +14,8 @@ 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`.
-It provides methods to start and stop voice recognition, and publishes the state of recognition and its availability.
+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
 
@@ -25,7 +25,7 @@ You need to add the SpeziSpeech Swift package to
 [your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or
 [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).
 
-> 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) setup the core Spezi infrastructure.
+> 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.
 
 ### 2. Configure the `SpeechRecognizer` in the Spezi `Configuration`
 

diff --git a/Sources/SpeziSpeechSynthesizer/SpeechSynthesizer.swift b/Sources/SpeziSpeechSynthesizer/SpeechSynthesizer.swift
@@ -10,10 +10,10 @@ import AVFoundation
 import Observation
 import Spezi
 
-/// 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 synthesization.
+/// 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) setup the core Spezi infrastructure.
+/// > 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.
 ///
 /// The module needs to be registered in a Spezi-based application using the [`configuration`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate/configuration)
 /// in a [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate):

diff --git a/...es/SpeziSpeechSynthesizer/SpeziSpeechSynthesizer.docc/SpeziSpeechSynthesizer.md b/...es/SpeziSpeechSynthesizer/SpeziSpeechSynthesizer.docc/SpeziSpeechSynthesizer.md
@@ -14,8 +14,8 @@ Provides text-to-speech capabilities via Apple's `AVFoundation` framework.
 
 ## Overview
 
-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 synthesization.
+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.
 
 ## Setup
 
@@ -25,7 +25,7 @@ You need to add the SpeziSpeech Swift package to
 [your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or
 [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).
 
-> 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) setup the core Spezi infrastructure.
+> 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.
 
 ### 2. Configure the `SpeechSynthesizer` in the Spezi `Configuration`