Skip to content

Commit

Permalink
Merge pull request #2 from fixie-ai/mike/pub-prep
Browse files Browse the repository at this point in the history
Prep for publishing
  • Loading branch information
mdepinet authored Sep 4, 2024
2 parents bb7d6ab + b133a84 commit e0dfcc0
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 3 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/deploy_web_example.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
on:
push:
branches: [main]

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: subosito/flutter-action@v2
with:
channel: 'stable'
- name: install deps
run: flutter pub get
- name: build
working-directory: ./example
run: |
flutter build web --release --web-renderer html --base-href /ultravox-client-sdk-flutter/
cd build/web
git init
git config --global user.email [email protected]
git config --global user.name gh-actions
git status
git remote add origin https://x-access-token:${{secrets.GITHUB_TOKEN}}@github.com/fixie-ai/ultravox-client-sdk-flutter.git
git checkout -b gh-pages
git add --all
git commit -m "update"
git push origin gh-pages -f
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Ultravox client SDK for Flutter
Flutter client SDK for [Ultravox](https://ultravox.ai).

<!-- TODO: Link to pub package once published.
[![pub package](https://img.shields.io/pub/v/ultravox_client?label=ultravox_client&color=orange)](https://pub.dev/packages/ultravox_client)
-->

## Getting started

Expand All @@ -28,3 +26,13 @@ state.addListener(myListener);
```

See the included example app 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/).

## Supported platforms

The Ultravox client SDK works on all Flutter platforms: Android, iOS, web, Linux, Windows, and macOS.

## Example app

You can view a demo of the example app at https://fixie-ai.github.io/ultravox-client-sdk-flutter/

You can use the [Ultravox REST API](https://fixie-ai.github.io/ultradox/) to get a `joinUrl`.
3 changes: 2 additions & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: ultravox_client
description: "Flutter client SDK for Ultravox."
version: 0.0.1
homepage: https://github.com/fixie-ai/ultravox-client-sdk-flutter
homepage: https://ultravox.ai
repository: https://github.com/fixie-ai/ultravox-client-sdk-flutter
topics:
- ultravox
- audio
Expand Down

0 comments on commit e0dfcc0

Please sign in to comment.