Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize and add details to README.md #443

Merged
merged 1 commit into from
May 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,22 @@
[![Translation status](https://hosted.weblate.org/widgets/twire/-/svg-badge.svg)](https://hosted.weblate.org/engage/twire/)


Twire is an open source, ad-free Twitch browser and stream player for Android. Supports VODs with chat replay, custom emotes (BTTV, FFZ and 7TV) and Picture in Picture mode.

This is a fork of the [Pocket Plays for Twitch](https://github.com/SebastianRask/Pocket-Plays-for-Twitch) Android application. More information [in this issue](https://github.com/SebastianRask/Pocket-Plays-for-Twitch/issues/1).
Twire is an open source, ad-free Twitch browser and stream player for Android.

This is a fork of the [Pocket Plays for Twitch](https://github.com/SebastianRask/Pocket-Plays-for-Twitch) Android application. You can find more information [in this issue](https://github.com/SebastianRask/Pocket-Plays-for-Twitch/issues/1).

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/com.perflyst.twire/)

## Current features

- Built-in adblock
- VODs with chat replay
- Custom emotes (BTTV, FFZ and 7TV)
- Picture in Picture mode
- Highly customizable UI
- Twitch account support

## Screenshots

Expand All @@ -25,16 +32,30 @@ This is a fork of the [Pocket Plays for Twitch](https://github.com/SebastianRask



## Contributing
## Making contributions

Developers are welcome to contribute to the project.
Feel free to open an issue and to submit a pull request.

The easiest way to contribute is by reporting issues. The other way involves making pull requests, which requires you to have a proper IDE installed (such as [Visual Studio Code](https://code.visualstudio.com/)) and a copy of the repository.

To clone the repository, run the following commands:
```
git clone https://github.com/twireapp/Twire
cd Twire
```
If you ever need to update your copy to the latest version, run:
```
git pull
```
If you'd like to learn more about making a pull request, please read [this GitHub article](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

### Translations

Translators can help translate Twire over on [Weblate](https://hosted.weblate.org/engage/twire/).

## Licensing

Twire is licensed under the [GNU v3 Public License.](https://github.com/Perflyst/Twire/blob/master/LICENSE)

As this is a fork under GNUv3 there were other developers involved.
Copyright notice for: [SebastianRask](https://github.com/SebastianRask), [alexzorin](https://github.com/alexzorin)
As this is a fork under GNUv3, other developers were involved.
Copyright notice for: [SebastianRask](https://github.com/SebastianRask), [alexzorin](https://github.com/alexzorin)