From 3d12e1675a92c6ab7c07917e5b92297c3df08850 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Loi=CC=88c=20Dumas?= Date: Wed, 5 Jun 2024 16:16:32 +0200 Subject: [PATCH 1/2] Fix Typo in documentation --- docs/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 268b8059c..6cf998441 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,7 +7,8 @@ [![Build status](https://img.shields.io/github/actions/workflow/status/SRGSSR/pillarbox-android/build.yml?label=Build)](https://github.com/SRGSSR/pillarbox-android/actions/workflows/build.yml) [![License](https://img.shields.io/github/license/SRGSSR/pillarbox-android?label=License)](https://github.com/SRGSSR/pillarbox-android/blob/main/LICENSE) -Pillarbox is the modern SRG SSR multimedia player ecosystem, built on top of [AndroiX Media3](https://developer.android.com/media/media3). Pillarbox has been designed with robustness, flexibility, and efficiency in mind, with full customization of: +Pillarbox is the modern SRG SSR multimedia player ecosystem, built on top of [AndroidX Media3](https://developer.android.com/media/media3). +Pillarbox has been designed with robustness, flexibility, and efficiency in mind, with full customization of: - Metadata and asset URL retrieval. - Asset resource loading, including support for Widevine and PlayReady. - Analytics integration. @@ -31,13 +32,13 @@ In addition, Pillarbox provides support for SRG SSR content by including the `pi ## Demo -You can easily get your hands on Pillarbox, by running one of the demo applications available in this project: [pillarbox-demo](../pillarbox-demo) for phone/tablet, or [pillarbox-demo-tv](../pillarbox-demo-tv) for TV. +You can easily get your hands on Pillarbox by running one of the demo applications available in this project: [pillarbox-demo](../pillarbox-demo) for phone/tablet, or [pillarbox-demo-tv](../pillarbox-demo-tv) for TV. Each application allows you to: - Try Pillarbox with various media types and sources. - See how Pillarbox answers various use cases (`pillarbox-demo` only). - Access a wide range of SRG SSR content. -- Search for a specific SRG SSR content. +- Search for specific SRG SSR content. ## Getting started From 6ec20533788c13d63a06ceef886c18826fc80e6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Loi=CC=88c=20Dumas?= Date: Wed, 5 Jun 2024 16:43:14 +0200 Subject: [PATCH 2/2] Fix typo in documentation --- docs/README.md | 2 +- pillarbox-analytics/docs/README.md | 6 +++--- pillarbox-ui/docs/README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 6cf998441..1c144630d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ [![License](https://img.shields.io/github/license/SRGSSR/pillarbox-android?label=License)](https://github.com/SRGSSR/pillarbox-android/blob/main/LICENSE) Pillarbox is the modern SRG SSR multimedia player ecosystem, built on top of [AndroidX Media3](https://developer.android.com/media/media3). -Pillarbox has been designed with robustness, flexibility, and efficiency in mind, with full customization of: +Pillarbox has been designed with robustness, flexibility, and efficiency in mind, with full customization of: - Metadata and asset URL retrieval. - Asset resource loading, including support for Widevine and PlayReady. - Analytics integration. diff --git a/pillarbox-analytics/docs/README.md b/pillarbox-analytics/docs/README.md index 411b514e2..8b5683908 100644 --- a/pillarbox-analytics/docs/README.md +++ b/pillarbox-analytics/docs/README.md @@ -19,7 +19,7 @@ implementation("ch.srgssr.pillarbox:pillarbox-analytics:$LATEST_RELEASE_VERSION" ### Configuration and create -Before using `SRGAnalytics` make sure to call `SRGAnalytics.init` first, otherwise it can lead to an undefined behavior. +Before using `SRGAnalytics` make sure to call `SRGAnalytics.init` first, otherwise it can lead to undefined behavior. It is strongly recommended to call the initializer inside your `Application.onCreate` method. ```kotlin @@ -74,7 +74,7 @@ User consent values will be updated with the next analytics event. ### Send page view -To send a page view use `SRGAnalytics.sendPageView`. It will trigger a CommandersActs and a Comscore page view event directly. +To send a page view use `SRGAnalytics.sendPageView`. It will trigger a CommandersAct and a Comscore page view event directly. ```kotlin val commandersActEvent = CommandersActPageView(name = "main", type = "tbd", levels = listOf("app", "pillarbox")) @@ -88,7 +88,7 @@ For Android Auto application it is not recommended to send page view. ### Send event -Events are application event the analytics team of the application want to track. It could be click event, user choice etc.. +Events are application events the analytics team of the application want to track. It could be click event, user choice etc.. ```kotlin SRGAnalytics.sendEvent(CommandersActEvent(name = "event")) diff --git a/pillarbox-ui/docs/README.md b/pillarbox-ui/docs/README.md index 5f785d5eb..5f1292e2b 100644 --- a/pillarbox-ui/docs/README.md +++ b/pillarbox-ui/docs/README.md @@ -5,7 +5,7 @@ # Pillarbox UI module -Provides UI Compose components : +Provides UI Compose components: - PlayerSurface - Exoplayer views compose wrappers