Skip to content

Commit 9220999

Browse files
committed
docs: clarify Android project overview
1 parent cfd4656 commit 9220999

1 file changed

Lines changed: 38 additions & 25 deletions

File tree

‎README.md‎

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<div align="center">
44
<img src="assets/banner.png" alt="TypeType" width="100%">
55
<h1>TypeType Android</h1>
6-
<p>Your TypeType library, in a fast native app for Android.</p>
6+
<p>Native Android client for TypeType.</p>
77
</div>
88

99
<div align="center">
@@ -21,16 +21,16 @@
2121
<a href="https://github.com/TypeType-Video/TypeType/issues">Report a problem</a>
2222
</p>
2323

24-
TypeType Android brings your self-hosted TypeType experience to phones and
25-
tablets. Browse your recommendations and subscriptions, search across supported
26-
platforms, continue where you stopped, and watch through a native player built
27-
for Android.
24+
TypeType Android is a native client for
25+
[TypeType](https://github.com/TypeType-Video/TypeType), a self-hosted video
26+
platform. It provides browsing, account synchronization, downloads, and native
27+
playback on Android phones and tablets.
2828

29-
The app communicates exclusively with the TypeType instance you choose. Your
30-
account, history, subscriptions, playlists, playback sessions, and downloads
31-
remain under the control of that instance.
29+
The app communicates exclusively with the TypeType instance selected during
30+
setup. Extraction, playback sessions, recommendations, synchronization, and
31+
server-side downloads remain server responsibilities.
3232

33-
## See it in action
33+
## Screenshots
3434

3535
| Home and Continue Watching | Search | Subscriptions |
3636
| --- | --- | --- |
@@ -48,20 +48,19 @@ These are real captures from the signed Android application connected to the
4848
TypeType beta with a demonstration account. The displayed content changes over
4949
time.
5050

51-
## Everything that matters, close at hand
51+
## Features
5252

53-
- Continue Watching keeps unfinished videos at the top of your home feed.
53+
- Resume unfinished videos from Continue Watching.
5454
- Search videos, channels, playlists, music, and other supported content.
55-
- Follow subscriptions and clearly identify live, premiere, and special videos.
56-
- Keep history, favorites, Watch Later, playlists, notifications, and profile
57-
settings together.
58-
- Watch with background audio, Picture in Picture, a mini-player, and an
59-
audio-only mode.
55+
- Browse subscriptions with labels for live, premiere, and special videos.
56+
- Access history, favorites, Watch Later, playlists, and notifications.
57+
- Use background audio, Picture in Picture, the mini-player, and audio-only
58+
playback.
6059
- Choose quality, codec, audio track, captions, playback speed, and image mode.
61-
- Use chapters, SponsorBlock controls, a queue, comments, related videos, and a
62-
sleep timer.
63-
- Download supported videos and keep useful cached content visible through
64-
temporary network interruptions.
60+
- Use chapters, SponsorBlock, the playback queue, comments, related videos, and
61+
the sleep timer.
62+
- Download supported videos and retain cached pages during temporary network
63+
interruptions.
6564
- Import existing data and manage multiple TypeType instances and accounts.
6665

6766
TypeType Android supports Android 6.0 and newer, and does not require Google
@@ -89,12 +88,12 @@ Debug build before installing the signed APK.
8988
> access to a compatible TypeType instance. If you want to host one, start with
9089
> the [self-hosting guide](https://typetype-video.github.io/Docs-TypeType/self-hosting/introduction).
9190
92-
## Built for unreliable mobile networks
91+
## Offline behavior and diagnostics
9392

94-
The app keeps locally cached pages visible while refreshing, resumes
95-
progressive feeds, and reacts to network loss and recovery without treating
96-
every interruption as a permanent failure. Playback, downloads, and account
97-
operations still depend on the selected instance and its upstream providers.
93+
The app keeps available local cache entries visible while refreshing and
94+
resumes progressive feeds after a temporary interruption. Playback, downloads,
95+
and account operations still depend on the selected instance and its upstream
96+
providers.
9897

9998
When something fails, open **Settings > Diagnostics** to review a redacted,
10099
local request history before sharing it. Diagnostics do not include raw
@@ -162,6 +161,20 @@ stored in this repository.
162161
- [Docs-TypeType](https://github.com/TypeType-Video/Docs-TypeType), user and
163162
self-hosting documentation
164163

164+
## Acknowledgements
165+
166+
TypeType Android is an independent client. The following GPL v3 projects have
167+
provided useful technical and product references:
168+
169+
- [PipePipe](https://github.com/InfinityLoop1308/PipePipe) and
170+
[PipePipeClient](https://github.com/InfinityLoop1308/PipePipeClient), for
171+
Android playback, format selection, SABR diagnostics, and compatibility
172+
lessons
173+
- [LibreTube](https://github.com/libre-tube/LibreTube), for Android video-client
174+
UX and Media3 playback lifecycle patterns
175+
- [Findroid](https://github.com/jarnedemeulemeester/findroid), for native
176+
server-first client architecture and multi-server setup patterns
177+
165178
## License
166179

167180
TypeType Android is licensed under the [GNU General Public License v3.0](LICENSE).

0 commit comments

Comments
 (0)