copilot/frosty
1
0
Fork 0
Code Issues Pull requests Projects Releases 11 Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Tommy Chow 2022-03-25 02:20:00 -04:00
parent 5f7b3500ab
commit f453595f2d
10 changed files with 78 additions and 207 deletions
Download patch file Download diff file Expand all files Collapse all files

104
README.md
View file

@ -1,23 +1,89 @@
# Frosty
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](LICENSE)
![CI](https://github.com/tommyxchow/frosty/actions/workflows/main.yml/badge.svg)
[![License: AGPL v3](https://img.shields.io/github/license/tommyxchow/frosty)](LICENSE)
[![CI](https://github.com/tommyxchow/frosty/actions/workflows/main.yml/badge.svg)](https://github.com/tommyxchow/frosty/actions/workflows/main.yml)
[![Version](https://img.shields.io/github/v/release/tommyxchow/frosty)](https://github.com/tommyxchow/frosty/releases/latest)
A [Twitch](https://www.twitch.tv/) client for iOS and Android, built with [Flutter](https://flutter.dev/).
A [Twitch](https://www.twitch.tv/) client for iOS and Android with [BTTV](https://betterttv.com/), [FFZ](https://www.frankerfacez.com/), and [7TV](https://7tv.app/) support. Built with [Flutter](https://flutter.dev/).
<p>
<a href="https://apps.apple.com/us/app/frosty-for-twitch/id1603987585" target="_blank">
<img align="center" alt="Get it on iOS (Apple TestFlight)" src="assets/badges/apple_app_store_badge.svg" width="200">
</a>
<a href="https://play.google.com/store/apps/details?id=com.tommychow.frosty" target="_blank">
<img align="center" alt="Get it on Android (Google Play Store)" src="assets/badges/google_play_store_badge.svg" width="225">
</a>
<a
href="https://apps.apple.com/us/app/frosty-for-twitch/id1603987585"
target="_blank"
>
<img
align="center"
alt="Get it on iOS (Apple TestFlight)"
src="https://user-images.githubusercontent.com/54859075/160051843-1d8b2186-97e9-4edd-a957-bb4797b71b4a.svg"
width="200"
/>
</a>
<a
href="https://play.google.com/store/apps/details?id=com.tommychow.frosty"
target="_blank"
>
<img
align="center"
alt="Get it on Android (Google Play Store)"
src="https://user-images.githubusercontent.com/54859075/160051854-21a57556-6b5a-41e9-8127-334daf1fac47.svg"
width="225"
/>
</a>
</p>
<a href="https://www.buymeacoffee.com/tommychow" target="_blank">
<img title="Support the App!" alt="Buy Me A Coffee" src="assets/badges/bmc-button.svg" width="200">
<img
title="Support the App!"
alt="Buy Me A Coffee"
src="https://user-images.githubusercontent.com/54859075/160051848-2e581476-a6c6-4de6-9af7-773d96632de1.svg"
width="200"
/>
</a>
## Screenshots
<p>
<img
title="Followed Streams"
alt="Followed Streams"
src="https://user-images.githubusercontent.com/54859075/160052219-efd07a9d-491b-430e-88d0-6a9146ebaf69.png"
width="32%"
/>
<img
title="Categories Section"
alt="Categories Section"
src="https://user-images.githubusercontent.com/54859075/160052212-9e0c74c4-658c-43b8-8d88-d6c9ae647acb.png"
width="32%"
/>
<img
title="Search Section"
alt="Search Section"
src="https://user-images.githubusercontent.com/54859075/160052221-4c256c11-4c19-4b18-a6bd-d1b1d39e4b69.png"
width="32%"
/>
</p>
<p>
<img
title="Channel (Video/Chat) View"
alt="Channel (Video/Chat) View"
src="https://user-images.githubusercontent.com/54859075/160052220-31e7575a-6140-430b-8c0a-b1f22919d637.png"
width="32%"
/>
<img
title="Emote Menu"
alt="Emote Menu"
src="https://user-images.githubusercontent.com/54859075/160052223-742b2fc0-6ef2-4f47-a343-3e5b6e288ad1.png"
width="32%"
/>
<img
title="Settings Section"
alt="Settings Section"
src="https://user-images.githubusercontent.com/54859075/160052222-91fd8b7a-f057-421e-97f6-1553e738fbbd.png"
width="32%"
/>
</p>
## Features
- Browse followed streams, top streams, and top categories
@ -32,20 +98,6 @@ A [Twitch](https://www.twitch.tv/) client for iOS and Android, built with [Flutt
- Picture-in-picture mode (iOS only)
- Customizable settings
## Screenshots
<p>
<img title="Followed Streams" alt="Followed Streams" src="screenshots/../assets/screenshots/followed.png" width="32%">
<img title="Categories Section" alt="Categories Section" src="screenshots/../assets/screenshots/categories.png" width="32%">
<img title="Search Section" alt="Search Section" src="screenshots/../assets/screenshots/search.png" width="32%">
</p>
<p>
<img title="Channel (Video/Chat) View" alt="Channel (Video/Chat) View" src="screenshots/../assets/screenshots/lirik.png" width="32%">
<img title="Emote Menu" alt="Emote Menu" src="screenshots/../assets/screenshots/soda.png" width="32%">
<img title="Settings Section" alt="Settings Section" src="screenshots/../assets/screenshots/settings.png" width="32%">
</p>
## Motivation
A major problem with the official Twitch app for many users is that emotes from services such as [BetterTTV (BTTV)](https://chrome.google.com/webstore/detail/betterttv/ajopnjidmegmdimjlfnijceegpefgped), [FrankerFaceZ (FFZ)](https://chrome.google.com/webstore/detail/frankerfacez/fadndhdgpmmaapbmfcknlfgcflmmmieb), and [7TV](https://chrome.google.com/webstore/detail/7tv/ammjkodgmmoknidbanneddgankgfejfh) are not officially supported. Twitch is unaffiliated with these services, hence why they haven't been integrated officially.
@ -100,7 +152,7 @@ This is caused by the Flutter framework and is being worked on (see [here](https
### Why is feature "X" from Twitch not in the app as well?
I'm limited to what is available in the [Twitch API](https://dev.twitch.tv/docs/api/reference), so certain features from the Twitch web or mobile app (e.g., voting on predictions) are sadly not available at the moment.
I'm limited to what is available in the [Twitch API](https://dev.twitch.tv/docs/api/reference), so certain features from the Twitch web or mobile app (e.g., voting on predictions and category viewer count) are sadly not available at the moment.
I'll try to add as many features as possible but occasionally I may take a break or be limited in time due to studies and personal reasons.
@ -110,4 +162,4 @@ You can open a new issue [here](https://github.com/tommyxchow/frosty/issues) wit
## License
Frosty is licensed under AGPLv3. See the [LICENSE](LICENSE) for more details.
Frosty is licensed under [AGPL-3.0-or-later](LICENSE).