twitch-tui/README.md

42 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

<div align="center">
2021-08-24 02:10:53 +03:00
# twitch-tui
2021-09-04 13:06:19 +03:00
Twitch chat in the terminal.
2023-05-03 14:44:52 +03:00
2024-05-11 12:49:18 +03:00
[![crates][s1]][l1] [![CI][s2]][l2] [![pre-commit.ci status][s3]][l3] [![unsafe][s4]][l4]
2023-05-03 14:44:52 +03:00
[s1]: https://img.shields.io/crates/v/twitch-tui.svg
[l1]: https://crates.io/crates/twitch-tui
[s2]: https://github.com/Xithrius/twitch-tui/actions/workflows/ci.yml/badge.svg
[l2]: https://github.com/Xithrius/twitch-tui/actions/workflows/ci.yml
[s3]: https://results.pre-commit.ci/badge/github/Xithrius/twitch-tui/main.svg
[l3]: https://results.pre-commit.ci/latest/github/Xithrius/twitch-tui/main
2024-05-11 12:49:18 +03:00
[s4]: https://img.shields.io/badge/unsafe-forbidden-success.svg
[l4]: https://github.com/rust-secure-code/safety-dance/
2023-05-03 14:44:52 +03:00
<img src="assets/preview.png" />
</div>
2022-12-16 03:08:02 +03:00
## Feature list
- Read/send/search messages
- Switch channels
- Create and toggle filters
- Command, channel, and mention suggestions
- Customize functionality and looks to your liking using a [config file](https://github.com/Xithrius/twitch-tui/blob/main/default-config.toml)
## Links
- [Documentation](https://xithrius.github.io/twitch-tui/)
- [Setup](https://xithrius.github.io/twitch-tui/guide/installation)
2021-09-04 13:06:19 +03:00
## More information
2022-02-22 13:13:35 +03:00
If you have any problems, do not hesitate to [submit an issue](https://github.com/Xithrius/twitch-tui/issues/new/choose).
2022-02-22 13:18:23 +03:00
Combine this application with [streamlink](https://github.com/streamlink/streamlink) to rid the need of a browser while watching streams.
2022-10-28 06:29:30 +03:00
This project follows the guidelines of [Semantic Versioning](https://semver.org/).