Update README.md

This commit is contained in:
dragongoose 2023-03-21 12:51:11 +00:00 committed by GitHub
parent 08f7432d84
commit d93be978bc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,5 +1,5 @@
# twitch-frontend
twitch-frontend is a privacy respecting frontend for (twitch.tv)[https://twitch.tv/]
twitch-frontend is a privacy respecting frontend for [twitch.tv](https://twitch.tv/)
The main advantages of twitch-frontend are:
- Private: Every request is proxied through the server, and no logs are kept.
@ -12,11 +12,18 @@ The main advantages of twitch-frontend are:
### User features
- [x] No connection to twitch/amazon
- [x] No Ads or tracking
- [x] No logs are kept
- [x] No outside connections, only connection is the instance
- [x] Uses [Vue](https://vuejs.org/) for a speedy experience
- [x] No identifiable logs are kept (see [logs](#so-what-is-logged))
- [x] Much smaller pages compared to Twitch (<600kb compared to >8.2mb)
### Technical features
- [x] Public API
- [x] No official APIs are used
- [x] Uses a mix of (streamlink)[] and a custom Twitch webscraper
- [x] Uses a custom Twitch webscraper
## So, what is logged?
You may have caught the "No identifiable logs are kept",
When the server encounters an error, a log is kept. The log only includes the error message, the time, and an id, which is also given to the user so the instance owner can investigate the issue. This is mainly only used for debugging, and can be disabled in the config.