Skip to content

Commit 102a8b9

Browse files
authored
Update README.md
Adjusted instructions upon new changes Added image and gif as well
1 parent 64cae8a commit 102a8b9

File tree

1 file changed

+66
-6
lines changed

1 file changed

+66
-6
lines changed

README.md

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,70 @@
1-
## Fire App Builder
1+
## Amazon Appstore Fire App Builder
22

3-
Fire App Builder is a java framework that allows developers to quickly build immersive, java based Android media applications for Fire TV, without writing code. Fire App Builder accomplishes this by using a plug and play java framework with easy configuration files. Developers simply specify the format of their media feed in a json file and add resources for logos and colors to create a rich media TV experience quickly. Fire App Builder supports multiple modules for Analytics, Authentication and Advertising that you can enable for your app.
3+
Fire App Builder provides a Java-based framework that you can use to easily and quickly build streaming media Android apps for Amazon Fire TV.
44

5-
## Documentation
65

7-
Full Documentation for Fire App Builder is located [here](https://developer.amazon.com/public/solutions/devices/fire-tv/docs/fire-app-builder-overview).
6+
## Prerequisites
87

9-
##
10-
Fire App Builder is java based and is built using Android Studio.
8+
* [**Android Studio**](http://developer.android.com/sdk/index.html)
9+
* [**Java Development Kit (JDK) 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
10+
* Virtual (TV emulator on Android Studio) or physical device ([**Fire TV**](https://www.amazon.com/firetv) or [**Fire TV Stick**](https://www.amazon.com/firetvstick))
11+
* **Media feed with necessary elements.** If you want to use your own custom media feed, you will need a media feed (in either JSON or XML format) with video assets as well as the following feed elements: title, ID, description, URL, card image, and background image. Any video format supported by [Exoplayer](https://google.github.io/ExoPlayer/supported-formats.html) is compatible with Fire App Builder
12+
13+
14+
15+
## ✅ Features
16+
17+
![Demo Screen](../assets/fire-app-splash.jpg?raw=true)
18+
* **Five screens**: Splash screen, Home (two layouts), Content Details, Content Renderer, and Search.
19+
* **Search functionality and search results**: Text search within your app. Also includes intent filters to integrate with the global Fire TV search if your media is integrated into the Amazon Catalog.
20+
* **Exoplayer-based Amazon media player for streaming media**: The media player includes closed [caption support](https://developer.amazon.com/docs/fire-app-builder/caption-support.html) (in-band and out-band), HTTP Live Streaming (HLS), bandwidth settings, and more.
21+
* **Components for ads, analytics, authorization, and in-app purchasing**: More than 10 components that you can easily plug into your app and configure through XML files. Some of these components include Amazon in-app purchases, Login with Amazon, Facebook Login, Omniture Analytics, Flurry Analytics, Adobe Pass Authentication, Freewheel ads, and VAST 2.0 ads.
22+
23+
24+
25+
## 💻 Building the Fire App Builder
26+
27+
1. Clone the following repository:
28+
`git clone git@github.com:amzn/fire-app-builder.git`
29+
2. Start Android Studio
30+
3. At the Welcome screen, click **Open an existing Android Studio project**.
31+
4. Browse to the directory where you downloaded the fire-app-builder GitHub project. Inside the Fire App Builder project folder, select the **Application** folder, and then click **Open**.
32+
5. Build → Make Project
33+
1. Try Build → Clean Project and Rebuild Project if nothing happens
34+
6. Run the app
35+
7. Within your emulator, under Your apps, you will see the Fire App Builder. When you click on it, it will load the app!
36+
37+
![Demo Screen](../assets/fire-app-builder.gif?raw=true)
38+
39+
## 🔥 Using Fire App Builder
40+
41+
Change the appearance.
42+
43+
* Change app loco, icon, font
44+
* Change different screens (splash, home)
45+
* Change homepage layout, sidebar
46+
47+
48+
Add [components](https://developer.amazon.com/docs/fire-app-builder/interfaces-and-components.html) for more functionality. No need to write your Java code, just customize various string values that have been extracted out of the code into XML files.
49+
50+
* Ads Interface (`IAds`): Used for displaying ads to users
51+
* Analytics Interface (`IAnalytics`): Used for implementing analytics
52+
* Authentication Interface (`IAuthentication`): Used for authenticating or authorizing user access to media
53+
* Purchase Interface (`IPurchase`): Used for in-app purchasing
54+
* UAMP (`UAMP`): Used for playing media. (UAMP stands for Universal Android Media Player.)
55+
56+
57+
58+
59+
## 🆘 Get support
60+
61+
If you found a bug or want to suggest a new [feature/use case/sample], please [file an issue.](https://github.com/amzn/fire-app-builder/issues)
62+
If you have questions, comments, or need help with code, we're here to help:
63+
64+
* on Twitter at [@AmazonAppDev](https://twitter.com/AmazonAppDev)
65+
* on Stack Overflow at the [amazon-appstore](https://stackoverflow.com/questions/tagged/amazon-appstore) tag
66+
67+
Sign up to [stay updated with the developer newsletter.](https://m.amazonappservices.com/subscribe-newsletter)
68+
69+
## ✍️ Author
70+
[@_yoolivia](https://twitter.com/_yoolivia?)

0 commit comments

Comments
 (0)