Skip to content

Commit

Permalink
docs: add some notes about the feature flags
Browse files Browse the repository at this point in the history
  • Loading branch information
ctron committed Mar 7, 2024
1 parent 484baef commit 985e14d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions site/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ Download the sources and build them yourself:
cargo install --locked trunk
```

You can also toggle some features using the `--features` flag:

<dl>
<dt><code>rustls</code> (default)</dt><dd>Use rustls for client and server sockets</dd>
<dt><code>native-tls</code></dt><dd>Enable the use of the system native TLS stack for client sockets, and `openssl` for server sockets</dd>
<dt><code>update_check</code> (default)</dt><dd>Enable the update check on startup</dd>
</dl>

**NOTE:** If both `rustls` and `native-tls` are enabled, `rustls` will be used. You can disable the default `rustls` using
`--no-default-features`.

### Cargo binstall

You can download a released binary from GitHub releases through [`binstall`](https://github.com/cargo-bins/cargo-binstall).
Expand Down

0 comments on commit 985e14d

Please sign in to comment.