Skip to content

Commit 7f74511

Browse files
committed
docs: improve some explanations
1 parent 9c0c4ac commit 7f74511

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,23 @@ If you have an existing Warp+ subscription, for example on your phone, you can b
4545
4646
First, get your Warp+ account license key. To view it on Android:
4747
1. Open the `1.1.1.1` app
48-
2. Click on the hamburger menu button on the top-right corner
48+
2. Click on the hamburger menu button in the top-right corner
4949
3. Navigate to: `Account` > `Key`
5050

5151
Now, back to wgcf.
5252

5353
> [!WARNING]
54-
> 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:
54+
> There's a bug on Cloudflare's side that prevents existing accounts from getting Warp+ even after you bind a correct license key. If you have ever connected to Warp VPN, then your account is affected. You will need to make a new account via:
5555
>
5656
> ```wgcf register
5757
> wgcf register
5858
> ```
59+
> Then immediately proceed with the steps below, without running any other commands. For more details, check [!85](https://github.com/ViRb3/wgcf/issues/85)
5960
60-
Immediately, before running any other commands, add your key to `wgcf-account.toml`. Finally, run:
61+
Run the following commands:
6162
6263
```bash
63-
wgcf update
64+
wgcf update --license-key "YOUR_LICENSE_KEY_GOES_HERE"
6465
wgcf generate
6566
```
6667
@@ -78,8 +79,12 @@ wgcf trace
7879
```
7980
If you look at the last line, it should say `warp=on` or `warp=plus`, depending on whether you have Warp or Warp+ respectively.
8081

82+
> [!WARNING]
83+
> If you're seeing `warp=on` even after you bound a Warp+ license key, you are likely experiencing a known bug, please refer to the [Add a license key](#add-a-license-key) section.
84+
8185
## Development
82-
To regenerate the Go client API code, [install openapi-generator](https://openapi-generator.tech/docs/installation), then run:
86+
The API client code is auto-generated from the OpenAPI spec [openapi-spec.yml](openapi-spec.yml) and stored under the [openapi/](openapi/) package. Do not touch any code under that package, instead, change the spec file and regenerate the API client code. To do this, [install openapi-generator](https://openapi-generator.tech/docs/installation), then run:
87+
8388
```bash
8489
go generate
8590
```

0 commit comments

Comments
 (0)