Skip to content

Commit

Permalink
docs(readme): improve readme with screenshots (#456)
Browse files Browse the repository at this point in the history
  • Loading branch information
outadoc authored Oct 5, 2024
1 parent 7c8839b commit 6fa1ff8
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,32 @@

An app focused on a great Twitch chat experience.

- iOS and Android support.
- Multi-chat. Open multiple chat bubbles, and switch between them (only on Android.)
- Tablet- and foldable-optimized interface.
- Custom emotes. If the default emotes aren't enough for you, we support third-party emote sets!
- Slide to reply to any message, and see the context of the conversation.
- See your favorite channels' schedule -- past, present, and future, in a unified timeline.

<table>
<tr>
<th>Android</th>
<th>iOS</th>
</tr>
<tr>
<td>

![](./assets/screenshots/android/chat-recording.mp4)

</td>
<td>

![](./assets/screenshots/ios/ipad-static.png)

</td>
</tr>
</table>

## Project setup

### Android
Expand All @@ -13,4 +39,4 @@ An app focused on a great Twitch chat experience.

1. Install Xcode 16;
2. Install [Tuist](https://docs.tuist.io/guides/quick-start/install-tuist);
2. Move to the `app-ios` directory, and run `tuist generate` to generate and open the Xcode project.
3. Move to the `app-ios` directory, and run `tuist generate` to generate and open the Xcode project.
Binary file added assets/screenshots/android/chat-recording.mp4
Binary file not shown.
Binary file added assets/screenshots/ios/ipad-static.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6fa1ff8

Please sign in to comment.