Skip to content

Commit

Permalink
add all crates to crate.md (book)
Browse files Browse the repository at this point in the history
  • Loading branch information
GlenDC committed Sep 5, 2024
1 parent 19cc4e7 commit 94987c6
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/book/src/crate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,32 @@ cargo add rama
* Edge (main branch): <https://ramaproxy.org/docs/rama/index.html>
* Github repo: <https://github.com/plabayo/rama>

## All Rama Crates

The `rama` crate can be used as the one and only dependency.
However, as you can also read in the "DIY" chapter of the book
at <https://ramaproxy.org/book/diy.html#empowering>, you are able
to pick and choose not only what specific parts of `rama` you wish to use,
but also in fact what specific (sub) crates.

Here is a list of all `rama` crates:

- [`rama`](https://crates.io/crates/rama): one crate to rule them all
- [`rama-error`](https://crates.io/crates/rama-error): error utilities for rama and its users
- [`rama-macros`](https://crates.io/crates/rama-macros): contains the procedural macros used by `rama`
- [`rama-utils`](https://crates.io/crates/rama-utils): utilities crate for rama
- [`rama-core`](https://crates.io/crates/rama-core): core crate containing the service, layer and
context used by all other `rama` code, as well as some other _core_ utilities
- [`rama-net`](https://crates.io/crates/rama-net): rama network types and utilities
- [`rama-tcp`](https://crates.io/crates/rama-tcp): TCP support for rama
- [`rama-tls`](https://crates.io/crates/rama-tls): TLS support for rama (types, `rustls` and `boring`)
- [`rama-proxy`](https://crates.io/crates/rama-proxy): proxy types and utilities for rama
- [`rama-haproxy`](https://crates.io/crates/rama-haproxy): rama HaProxy support
- [`rama-ua`](https://crates.io/crates/rama-ua): User-Agent (UA) support for `rama`
- [`rama-http-types`](https://crates.io/crates/rama-http-types): http types and utilities
- [`rama-http`](https://crates.io/crates/rama-http): rama http services, layers and utilities
- [`rama-http-backend`](https://crates.io/crates/rama-http-backend): default http backend for `rama`

## Examples

Examples to help you get started can be found in
Expand Down

0 comments on commit 94987c6

Please sign in to comment.