Skip to content

Commit

Permalink
Update README (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdepinet authored Oct 18, 2024
1 parent 1a72a8e commit f857120
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# ultravox-client-sdk-ios
iOS client SDK for Ultravox.
# Ultravox client SDK for iOS
iOS client SDK for [Ultravox](https://ultravox.ai).

[![swift package](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffixie-ai%2Fultravox-client-sdk-ios%2Fbadge%3Ftype%3Dswift-versions&color=orange)](https://swiftpackageindex.com/fixie-ai/ultravox-client-sdk-ios)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffixie-ai%2Fultravox-client-sdk-ios%2Fbadge%3Ftype%3Dplatforms&color=orange)](https://swiftpackageindex.com/fixie-ai/ultravox-client-sdk-ios)

## Getting started

Using XCode, under `Project Settings` -> `Swift Packages` add a new package: `https://github.com/fixie-ai/ultravox-client-sdk-ios`

Or you can directly add to your `Package.swift`:

```swift
let package = Package(
...
dependencies: [
.package(url: "https://github.com/fixie-ai/ultravox-client-sdk-ios.git", .upToNextMajor("0.0.1")),
],
targets: [
.target(
name: "MyApp",
dependencies: [
.product(name: "Ultravox", package: "ultravox-client-sdk-ios"),
]
),
]
)
```

## Usage

```swift
let session = UltravoxSession()
await session.joinCall(joinUrl: "joinUrlFromYourServer");
await session.leaveCall();
```

See the example app at https://github.com/fixie-ai/ultravox-client-sdk-ios-example for a more complete example. To get a `joinUrl`, you'll want to integrate your server with the [Ultravox REST API](https://fixie-ai.github.io/ultradox/).

0 comments on commit f857120

Please sign in to comment.