diff --git a/README.md b/README.md index cb590b93..dec43b7a 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,112 @@ -# 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) - -A [Twitch](https://www.twitch.tv/) client for iOS and Android, built with [Flutter](https://flutter.dev/). - -

- - Get it on iOS (Apple TestFlight) - - - Get it on Android (Google Play Store) - +

+ Frosty Logo +

Frosty

- - Buy Me A Coffee - +

+ A Twitch client for iOS and Android with + BTTV, + FFZ, and + 7TV support. Built with + Flutter. +

+ + +

+ + CI + + + License + + + Release + +

+ +

+ + Apple App Store Badge + + + Google Play Store Badge + +

+ +

+ + Buy Me A Coffee + +

+ +

+ Followed Streams + Categories Section + Search Section + Channel (Video/Chat) View + Emote Menu + Settings Section +

## Features @@ -32,20 +122,6 @@ A [Twitch](https://www.twitch.tv/) client for iOS and Android, built with [Flutt - Picture-in-picture mode (iOS only) - Customizable settings -## Screenshots - -

- Followed Streams - Categories Section - Search Section -

- -

- Channel (Video/Chat) View - Emote Menu - Settings Section -

- ## 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 +176,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 +186,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). diff --git a/assets/badges/apple_app_store_badge.svg b/assets/badges/apple_app_store_badge.svg deleted file mode 100755 index 072b425a..00000000 --- a/assets/badges/apple_app_store_badge.svg +++ /dev/null @@ -1,46 +0,0 @@ - - Download_on_the_App_Store_Badge_US-UK_RGB_blk_4SVG_092917 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/assets/badges/bmc-button.svg b/assets/badges/bmc-button.svg deleted file mode 100644 index 4754bd34..00000000 --- a/assets/badges/bmc-button.svg +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/assets/badges/google_play_store_badge.svg b/assets/badges/google_play_store_badge.svg deleted file mode 100644 index a01a8d87..00000000 --- a/assets/badges/google_play_store_badge.svg +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - - - -]> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/assets/screenshots/categories.png b/assets/screenshots/categories.png deleted file mode 100644 index 2f03d105..00000000 Binary files a/assets/screenshots/categories.png and /dev/null differ diff --git a/assets/screenshots/followed.png b/assets/screenshots/followed.png deleted file mode 100644 index 97cfca44..00000000 Binary files a/assets/screenshots/followed.png and /dev/null differ diff --git a/assets/screenshots/lirik.png b/assets/screenshots/lirik.png deleted file mode 100644 index 351c4c55..00000000 Binary files a/assets/screenshots/lirik.png and /dev/null differ diff --git a/assets/screenshots/search.png b/assets/screenshots/search.png deleted file mode 100644 index 30cbb5ca..00000000 Binary files a/assets/screenshots/search.png and /dev/null differ diff --git a/assets/screenshots/settings.png b/assets/screenshots/settings.png deleted file mode 100644 index 77b7303d..00000000 Binary files a/assets/screenshots/settings.png and /dev/null differ diff --git a/assets/screenshots/soda.png b/assets/screenshots/soda.png deleted file mode 100644 index 800446c6..00000000 Binary files a/assets/screenshots/soda.png and /dev/null differ