Update README.md

README.md

@@ -1,46 +1,29 @@
-# test
+# twitch-frontend
+twitch-frontend is a privacy respecting frontend for [twitch.tv](https://twitch.tv/)
 
-This template should help get you started developing with Vue 3 in Vite.
+The main advantages of twitch-frontend are:
+ - Private: Every request is proxied through the server, and no logs are kept.
+ - Lightweight: Compared to twitch, twitch-frontend is optimized for speed and usability. Scraping is the only current speed issue, but improves with caching
  
-## Recommended IDE Setup
+ </br>
  
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+ # Features
  
-## Type Support for `.vue` Imports in TS
+ ### User features
+ - [x] No connection to twitch/amazon
+ - [x] No Ads or tracking
+ - [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)
  
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+ ### Technical features
+ - [x] Public API
+ - [x] No official APIs are used
+ - [x] Uses a custom Twitch webscraper
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
  
-1. Disable the built-in TypeScript Extension
-    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
  
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
-
-```sh
-npm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
-```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
-```
-
-### Lint with [ESLint](https://eslint.org/)
-
-```sh
-npm run lint
-```
+ ## 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.