Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
PSchmiedmayer committed Nov 14, 2023
1 parent 5ac2ccf commit 6718be7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class ExampleAppDelegate: SpeziAppDelegate {

## Example

`MyDeviceModel` demonstrates the capabilities of the Spezi Bluetooth module.
`MyDeviceModule` demonstrates the capabilities of the Spezi Bluetooth module.
This class integrates the [`Bluetooth`](https://swiftpackageindex.com/stanfordspezi/spezibluetooth/documentation/spezibluetooth/bluetooth) module to create a `MyDevice` instance injected in the SwiftUI environment to send string messages over Bluetooth and collect them in a messages array.

> [!NOTE]
Expand All @@ -74,7 +74,7 @@ import Spezi
import SpeziBluetooth


public class MyDeviceModel: DefaultInitializable, Module { // your model the app configures
public class MyDeviceModule: DefaultInitializable, Module {
/// Spezi dependency injection of the `Bluetooth` module; see https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/module-dependency for more details.
@Dependency private var bluetooth: Bluetooth
/// Injecting the `MyDevice` class in the SwiftUI environment as documented at https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/interactions-with-swiftui
Expand Down
4 changes: 2 additions & 2 deletions Sources/SpeziBluetooth/SpeziBluetooth.docc/SpeziBluetooth.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class ExampleAppDelegate: SpeziAppDelegate {

## Example

`MyDeviceModel` demonstrates the capabilities of the Spezi Bluetooth module.
`MyDeviceModule` demonstrates the capabilities of the Spezi Bluetooth module.
This class integrates the ``Bluetooth`` module to create a `MyDevice` instance injected in the SwiftUI environment to send string messages over Bluetooth and collect them in a messages array.

> Tip: The type uses the Spezi dependency injection of the `Bluetooth` module, the most common usage of the ``Bluetooth`` module. [You can learn more about the Spezi dependency injection mechanisms in the Spezi documentation](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/module-dependency).
Expand All @@ -64,7 +64,7 @@ import Spezi
import SpeziBluetooth


public class MyDeviceModel: DefaultInitializable, Module { // your model the app configures
public class MyDeviceModule: DefaultInitializable, Module {
/// Spezi dependency injection of the `Bluetooth` module; see https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/module-dependency for more details.
@Dependency private var bluetooth: Bluetooth
/// Injecting the `MyDevice` class in the SwiftUI environment as documented at https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/interactions-with-swiftui
Expand Down

0 comments on commit 6718be7

Please sign in to comment.