Skip to content

Commit dc66053

Browse files
authored
Update README.md (#89)
[skip ci]
1 parent 6755e4b commit dc66053

File tree

10 files changed

+106
-211
lines changed

10 files changed

+106
-211
lines changed

README.md

Lines changed: 106 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,112 @@
1-
# Frosty
1+
<p align="center">
2+
<img src="https://user-images.githubusercontent.com/54859075/160067655-f96b7e62-67f7-43d6-96ea-19ac85418bf6.svg" width="180px" alt="Frosty Logo" />
3+
<h1 align="center">Frosty</h1>
4+
</p>
5+
6+
<p align="center">
7+
A <a href="https://www.twitch.tv/">Twitch</a> client for iOS and Android with
8+
<a href="https://betterttv.com/">BTTV</a>,
9+
<a href="https://www.frankerfacez.com/">FFZ</a>, and
10+
<a href="https://7tv.app/">7TV</a> support. Built with
11+
<a href="https://flutter.dev/">Flutter</a>.
12+
</p>
213

3-
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](LICENSE)
4-
![CI](https://github.com/tommyxchow/frosty/actions/workflows/main.yml/badge.svg)
514

6-
A [Twitch](https://www.twitch.tv/) client for iOS and Android, built with [Flutter](https://flutter.dev/).
15+
<p align="center">
16+
<a href="https://github.com/tommyxchow/frosty/actions/workflows/main.yml">
17+
<img
18+
alt="CI"
19+
src="https://github.com/tommyxchow/frosty/actions/workflows/main.yml/badge.svg"
20+
/>
21+
</a>
22+
<a href="https://github.com/tommyxchow/frosty/blob/main/LICENSE">
23+
<img
24+
alt="License"
25+
src="https://img.shields.io/github/license/tommyxchow/frosty"
26+
/>
27+
</a>
28+
<a href="https://github.com/tommyxchow/frosty/releases/latest">
29+
<img
30+
alt="Release"
31+
src="https://img.shields.io/github/v/release/tommyxchow/frosty"
32+
/>
33+
</a>
34+
</p>
35+
36+
<p align="center">
37+
<a
38+
href="https://apps.apple.com/us/app/frosty-for-twitch/id1603987585"
39+
target="_blank"
40+
>
41+
<img
42+
title="Get it on iOS (Apple App Store)"
43+
alt="Apple App Store Badge"
44+
src="https://user-images.githubusercontent.com/54859075/160051843-1d8b2186-97e9-4edd-a957-bb4797b71b4a.svg"
45+
width="200px"
46+
/>
47+
</a>
48+
<a
49+
href="https://play.google.com/store/apps/details?id=com.tommychow.frosty"
50+
target="_blank"
51+
>
52+
<img
53+
title="Get it on Android (Google Play Store)"
54+
alt="Google Play Store Badge"
55+
src="https://user-images.githubusercontent.com/54859075/160051854-21a57556-6b5a-41e9-8127-334daf1fac47.svg"
56+
width="225px"
57+
/>
58+
</a>
59+
</p>
760

8-
<p>
9-
<a href="https://apps.apple.com/us/app/frosty-for-twitch/id1603987585" target="_blank">
10-
<img align="center" alt="Get it on iOS (Apple TestFlight)" src="assets/badges/apple_app_store_badge.svg" width="200">
11-
</a>
12-
<a href="https://play.google.com/store/apps/details?id=com.tommychow.frosty" target="_blank">
13-
<img align="center" alt="Get it on Android (Google Play Store)" src="assets/badges/google_play_store_badge.svg" width="225">
14-
</a>
61+
<p align="center">
62+
<a href="https://www.buymeacoffee.com/tommychow" target="_blank">
63+
<img
64+
title="Support the App!"
65+
alt="Buy Me A Coffee"
66+
src="https://user-images.githubusercontent.com/54859075/160051848-2e581476-a6c6-4de6-9af7-773d96632de1.svg"
67+
width="200px"
68+
/>
69+
</a>
1570
</p>
1671

17-
<a href="https://www.buymeacoffee.com/tommychow" target="_blank">
18-
<img title="Support the App!" alt="Buy Me A Coffee" src="assets/badges/bmc-button.svg" width="200">
19-
</a>
72+
<p align="center">
73+
<img
74+
title="Followed Streams"
75+
alt="Followed Streams"
76+
src="https://user-images.githubusercontent.com/54859075/160052219-efd07a9d-491b-430e-88d0-6a9146ebaf69.png"
77+
width="32%"
78+
/>
79+
<img
80+
title="Categories Section"
81+
alt="Categories Section"
82+
src="https://user-images.githubusercontent.com/54859075/160052212-9e0c74c4-658c-43b8-8d88-d6c9ae647acb.png"
83+
width="32%"
84+
/>
85+
<img
86+
title="Search Section"
87+
alt="Search Section"
88+
src="https://user-images.githubusercontent.com/54859075/160052221-4c256c11-4c19-4b18-a6bd-d1b1d39e4b69.png"
89+
width="32%"
90+
/>
91+
<img
92+
title="Channel (Video/Chat) View"
93+
alt="Channel (Video/Chat) View"
94+
src="https://user-images.githubusercontent.com/54859075/160052220-31e7575a-6140-430b-8c0a-b1f22919d637.png"
95+
width="32%"
96+
/>
97+
<img
98+
title="Emote Menu"
99+
alt="Emote Menu"
100+
src="https://user-images.githubusercontent.com/54859075/160052223-742b2fc0-6ef2-4f47-a343-3e5b6e288ad1.png"
101+
width="32%"
102+
/>
103+
<img
104+
title="Settings Section"
105+
alt="Settings Section"
106+
src="https://user-images.githubusercontent.com/54859075/160052222-91fd8b7a-f057-421e-97f6-1553e738fbbd.png"
107+
width="32%"
108+
/>
109+
</p>
20110

21111
## Features
22112

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

35-
## Screenshots
36-
37-
<p>
38-
<img title="Followed Streams" alt="Followed Streams" src="screenshots/../assets/screenshots/followed.png" width="32%">
39-
<img title="Categories Section" alt="Categories Section" src="screenshots/../assets/screenshots/categories.png" width="32%">
40-
<img title="Search Section" alt="Search Section" src="screenshots/../assets/screenshots/search.png" width="32%">
41-
</p>
42-
43-
<p>
44-
<img title="Channel (Video/Chat) View" alt="Channel (Video/Chat) View" src="screenshots/../assets/screenshots/lirik.png" width="32%">
45-
<img title="Emote Menu" alt="Emote Menu" src="screenshots/../assets/screenshots/soda.png" width="32%">
46-
<img title="Settings Section" alt="Settings Section" src="screenshots/../assets/screenshots/settings.png" width="32%">
47-
</p>
48-
49125
## Motivation
50126

51127
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
100176

101177
### Why is feature "X" from Twitch not in the app as well?
102178

103-
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.
179+
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.
104180

105181
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.
106182

@@ -110,4 +186,4 @@ You can open a new issue [here](https://github.com/tommyxchow/frosty/issues) wit
110186

111187
## License
112188

113-
Frosty is licensed under AGPLv3. See the [LICENSE](LICENSE) for more details.
189+
Frosty is licensed under [AGPL-3.0-or-later](LICENSE).

assets/badges/apple_app_store_badge.svg

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)