From c5a1cf6ae7c939c5fc3ba056338a266b06165fd9 Mon Sep 17 00:00:00 2001 From: Victor Date: Mon, 9 Dec 2024 19:54:47 +0000 Subject: [PATCH] docs: clarify key installation and usage --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0d864ca..6660307 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,11 @@ The WireGuard profile will be saved under `wgcf-profile.conf`. For more informat To ensure maximum compatibility, the generated profile will have a MTU of 1280, just like the official Android app. If you are experiencing performance issues, you may be able to improve your speed by increasing this value. For more information, please check [#40](https://github.com/ViRb3/wgcf/issues/40). ### Add a license key -If you have an existing Warp+ subscription, for example on your phone, you can bind the account generated by this tool to your phone's account, sharing its Warp+ status. Please note that there is a current limit of maximum of 5 linked devices active at a time. + +If you have an existing Warp+ subscription, for example on your phone, you can bind the account generated by this tool to your phone's account, sharing its Warp+ status. Please note that there is a limit of 5 maximum devices linked at a time. You can remove linked devices from the 1.1.1.1 app on your phone. + +> [!CAUTION] +> Only subscriptions purchased directly from the official 1.1.1.1 app are supported. Keys obtained by any other means will not work and will not be supported. First, get your Warp+ account license key. To view it on Android: 1. Open the `1.1.1.1` app @@ -46,11 +50,14 @@ First, get your Warp+ account license key. To view it on Android: Now, back to wgcf. -> :warning: If you have an existing account, you will need to delete it and create a new one ([!355](https://github.com/ViRb3/wgcf/pull/355), [!425](https://github.com/ViRb3/wgcf/pull/425)): +> [!WARNING] +> If you have an existing account, you will need to delete it and create a new one ([!355](https://github.com/ViRb3/wgcf/pull/355), [!425](https://github.com/ViRb3/wgcf/pull/425)). Otherwise, just run the same command to make your first account: +> > ```wgcf register > wgcf register > ``` -Then, immediately add your key to `wgcf-account.toml`. Finally, run: + +Immediately, before running any other commands, add your key to `wgcf-account.toml`. Finally, run: ```bash wgcf update