Skip to content

Commit

Permalink
docs(readme): mention the available feature flags
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed May 17, 2023
1 parent bfe78c0 commit 8359aad
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8359aad

Please sign in to comment.