From 8359aadec68cfcf88fcc91f214438eeaa8765ca8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= Date: Wed, 17 May 2023 14:04:32 +0300 Subject: [PATCH] docs(readme): mention the available feature flags --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 0e6bafc..705370a 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,20 @@ cd rustypaste/ 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 ##### Unit tests