diff --git a/README.md b/README.md index ba15f3b..55b88da 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Tesla Auth -[![CI](https://github.com/adriankumpf/tesla_auth/actions/workflows/ci.yml/badge.svg)](https://github.com/adriankumpf/tesla_auth/actions/workflows/ci.yml) -[![CD](https://github.com/adriankumpf/tesla_auth/actions/workflows/cd.yml/badge.svg)](https://github.com/adriankumpf/tesla_auth/actions/workflows/cd.yml) +[![CI](https://github.com/adriankumpf/tesla_auth/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/adriankumpf/tesla_auth/actions/workflows/ci.yml) +[![CD](https://github.com/adriankumpf/tesla_auth/actions/workflows/cd.yml/badge.svg?branch=main)](https://github.com/adriankumpf/tesla_auth/actions/workflows/cd.yml) Securely generate API tokens for third-party access to your Tesla. @@ -9,9 +9,11 @@ Multi-factor authentication (MFA) and Captcha are supported. ## Download +> _Precompiled binaries are currently only available for x86-64._ + - [macOS](https://github.com/adriankumpf/tesla_auth/releases/latest/download/tesla-auth-macos.tar.gz) - [Linux](https://github.com/adriankumpf/tesla_auth/releases/latest/download/tesla-auth-linux.tar.gz) -- [Windows (untested)](https://github.com/adriankumpf/tesla_auth/releases/latest/download/tesla-auth-windows.tar.gz) +- [Windows](https://github.com/adriankumpf/tesla_auth/releases/latest/download/tesla-auth-windows.tar.gz) ## Usage @@ -28,8 +30,18 @@ Options: ## Platform-specific dependencies +### macOS + +WebKit is native on macOS so **no additional dependencies** are required. + +### Windows + +WebView2 is powered by Microsoft Edge (Chromium). At the moment it **requires a preview version of Edge** which can be downloaded here: [Microsoft Edge Insider Channels](https://www.microsoftedgeinsider.com/en-us/download) + ### Linux +[WebKitGTK](https://webkitgtk.org/) is required for WebView. So please make sure following packages are installed: + #### Arch Linux / Manjaro: ```bash @@ -48,14 +60,6 @@ sudo apt install libwebkit2gtk-4.0-dev libappindicator3-dev sudo dnf install gtk3-devel webkit2gtk3-devel libappindicator-gtk3-devel ``` -### macOS - -WebKit is native on macOS so no additional dependencies are required. - -### Windows - -WebView2 is powered by Microsoft Edge (Chromium). So Windows 7, 8, and 10 should be supported. - ## License Apache-2.0/MIT