Skip to content

Commit 73dc11a

Browse files
committed
docs: clarified perseus-integration crate purpose
1 parent ad099ba commit 73dc11a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

packages/perseus-integration/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
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.
44

55
In other words, this is an internal convenience package used for testing.
6+
7+
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.

0 commit comments

Comments
 (0)