From 73dc11afe31f676d4a4d13f3eb24e7df0d4c57b4 Mon Sep 17 00:00:00 2001 From: arctic_hen7 Date: Mon, 4 Jul 2022 14:21:44 +1000 Subject: [PATCH] docs: clarified `perseus-integration` crate purpose --- packages/perseus-integration/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/perseus-integration/README.md b/packages/perseus-integration/README.md index 6b2ad02f3c..0b4a171768 100644 --- a/packages/perseus-integration/README.md +++ b/packages/perseus-integration/README.md @@ -3,3 +3,5 @@ It merely collates all the currently supported integrations and re-exposes their default servers through feature flags, enabling each of the examples to bring in just one dependency and then support all integrations through feature flags on this crate, which are specified by the CI testing framework. In other words, this is an internal convenience package used for testing. + +If you've come here trying to figure out how to use an actual integration instead of this internal package, you can easily replace the `perseus-integration` crate in your `Cargo.toml` with any of the supported server integrations, like `perseus-warp`. Then, just use `perseus_warp::dflt_server` instead of `perseus_integration::dflt_server` in your `#[perseus::main(...)]` declaration.