docs(readme): mention the available feature flags

This commit is contained in:
Orhun Parmaksız 2023-05-17 14:04:32 +03:00
parent bfe78c067e
commit 8359aadec6
No known key found for this signature in database
GPG key ID: F83424824B3E4B90

View file

@ -84,6 +84,20 @@ cd rustypaste/
cargo build --release cargo build --release
``` ```
#### Feature flags
- `shuttle`: enable an entry point for deploying on Shuttle
- `openssl`: use distro OpenSSL (binary size is reduced ~20% in release mode)
- `rustls`: use [rustls](https://github.com/rustls/rustls) (enabled as default)
To enable a feature for build, pass `--features` flag to `cargo build` command.
For example, to reuse the OpenSSL present on a distro already:
```sh
cargo build --release --features openssl
```
#### Testing #### Testing
##### Unit tests ##### Unit tests