Skip to content

Commit

Permalink
Add more details into Module.md and move it to docs/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MGaetan89 committed Oct 29, 2024
1 parent c33327e commit 81e503b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 29 deletions.
9 changes: 0 additions & 9 deletions pillarbox-cast/Module.md

This file was deleted.

33 changes: 13 additions & 20 deletions pillarbox-cast/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,29 @@
[![Pillarbox logo](https://github.com/SRGSSR/pillarbox-apple/blob/main/docs/README-images/logo.jpg)](https://github.com/SRGSSR/pillarbox-android)
[![Last release](https://img.shields.io/github/v/release/SRGSSR/pillarbox-android?label=Release)](https://github.com/SRGSSR/pillarbox-android/releases)
[![Android min SDK](https://img.shields.io/badge/Android-21%2B-34A853)](https://github.com/SRGSSR/pillarbox-android)
[![License](https://img.shields.io/github/license/SRGSSR/pillarbox-android?label=License)](https://github.com/SRGSSR/pillarbox-android/blob/main/LICENSE)
# Module pillarbox-cast

# Pillarbox Cast module

This module provides helpers to integrate cast with Pillarbox.
Provides helpers to integrate Cast with Pillarbox.

## Integration

```gradle
implementation("ch.srgssr.pillarbox:pillarbox-cast:$LATEST_RELEASE_VERSION")
```

More information can be found on the [top level README](../../docs/README.md)
To use this module, add the following dependency to your project's `build.gradle`/`build.gradle.kts` file:

## Documentation
- [Getting started](#getting-started)
- [Tracking](./MediaItemTracking.md)
- [Google Cast SDK](https://developers.google.com/cast/docs/android_sender)
## Known issues
- Nothing.
```kotlin
implementation("ch.srgssr.pillarbox:pillarbox-cast:<pillarbox_version>")
```

## Getting started

### Get the unique instance of CastContext.
### Get the `CastContext` instance

```kotlin
val castContext = context.getCastContext()
```
## Display the MediaRouteButton

### Display a Cast button

```kotlin
CastButton(modifier = Modifier)
```

## Additional resources

- [Google Cast SDK](https://developers.google.com/cast/docs/android_sender)

0 comments on commit 81e503b

Please sign in to comment.