mirror of
https://github.com/amigan/rustypaste-pretty.git
synced 2024-11-21 20:09:48 -05:00
docs(readme): mention the available feature flags
This commit is contained in:
parent
bfe78c067e
commit
8359aadec6
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
@ -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
|
||||||
|
|
Loading…
Reference in a new issue