Skip to content

Commit

Permalink
docs: clarified perseus-integration crate purpose
Browse files Browse the repository at this point in the history
  • Loading branch information
arctic-hen7 committed Jul 4, 2022
1 parent ad099ba commit 73dc11a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions packages/perseus-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 73dc11a

Please sign in to comment.