Update the README file

loopsocial · Nov 9, 2022 · 2acf15d · 2acf15d
1 parent f656494
commit 2acf15d
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,72 @@
 # Firework Android SDK Examples
 This repo holds the Firework Android SDK example applications.
 
-You can read the integration doc here:
-https://docs.firework.tv/
+**List of example apps:**
+
+* [View Options](#view-options-example-app)
+* [Discovery](#discovery-example-app)
+* [Channel](#channel-example-app)
+* [Playlist](#playlist-example-app)
+* [Shopping](#shopping-example-app)
+
+**Read more about the integration here** https://docs.firework.tv/
+
+---
+
+## View Options example app
+
+This example app demonstrates all possible view options that can be used for the `VideoFeedView` initialization.
+
+[View Options example app](view_options)
+
+| Customized View Options                                  | Player screen                                            |
+| -------------------------------------------------------- | -------------------------------------------------------- |
+| ![View Options Screenshot](view_options/Screenshot1.png) | ![View Options Screenshot](view_options/Screenshot2.png) |
+
+---
 
 ## Discovery example app
+
+In this example app, the `VideoFeedView` is initialized for showing a discovery feed.
+
 [Discovery example app](discovery)
 
-|           Main screen           |          Player screen          |
-| ------------------------------- | ------------------------------- |
-| ![Screenshot1](Screenshot1.png) | ![Screenshot2](Screenshot2.png) |
+| Discovery Feed                                     | Player screen                                      |
+| -------------------------------------------------- | -------------------------------------------------- |
+| ![discovery Screenshot](discovery/Screenshot1.png) | ![discovery Screenshot](discovery/Screenshot2.png) |
+
+---
+
+## Channel example app
+
+In this example app, the `VideoFeedView` is initialized for showing a channel feed.
+
+[Channel example app](channel)
+
+| Channel Feed                                     | Player screen                                      |
+| -------------------------------------------------- | -------------------------------------------------- |
+| ![channel Screenshot](channel/Screenshot1.png) | ![channel Screenshot](channel/Screenshot2.png) |
+
+---
+
+## Playlist example app
+
+In this example app, the `VideoFeedView` is initialized for showing a playlist feed.
+
+[Playlist example app](playlist)
+
+| Playlist Feed                                     | Player screen                                      |
+| -------------------------------------------------- | -------------------------------------------------- |
+| ![playlist Screenshot](playlist/Screenshot1.png) | ![playlist Screenshot](playlist/Screenshot2.png) |
+
+---
 
 ## Shopping example app
+
+In this example app, the `VideoFeedView` is initialized and integrated with the shopping features of the SDK.
+
 [Shopping example app](shopping)
 
 |         Shopping Button         |          Shopping Cart          |
 | ------------------------------- | ------------------------------- |
-| ![Screenshot1](Screenshot3.png) | ![Screenshot2](Screenshot4.png) |
+| ![shopping Screenshot](shopping/Screenshot1.png) | ![shopping Screenshot](shopping/Screenshot2.png) |
diff --git a/Screenshot1.png b/Screenshot1.png
diff --git a/Screenshot2.png b/Screenshot2.png
diff --git a/channel/Screenshot1.png b/channel/Screenshot1.png
diff --git a/channel/Screenshot2.png b/channel/Screenshot2.png
diff --git a/discovery/Screenshot1.png b/discovery/Screenshot1.png
diff --git a/discovery/Screenshot2.png b/discovery/Screenshot2.png
diff --git a/playlist/Screenshot1.png b/playlist/Screenshot1.png
diff --git a/playlist/Screenshot2.png b/playlist/Screenshot2.png
diff --git a/Screenshot3.png → shopping/Screenshot1.png b/Screenshot3.png → shopping/Screenshot1.png
diff --git a/Screenshot4.png → shopping/Screenshot2.png b/Screenshot4.png → shopping/Screenshot2.png
diff --git a/view_options/Screenshot1.png b/view_options/Screenshot1.png
diff --git a/view_options/Screenshot2.png b/view_options/Screenshot2.png