Skip to content

Commit

Permalink
Improve readme for embedded router.
Browse files Browse the repository at this point in the history
  • Loading branch information
bryn committed Apr 29, 2022
1 parent 69833be commit 7aed9ee
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions examples/embedded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@

:exclamation: Here be dragons! :exclamation:

It is possible to run the router outside the default bundled web server (Warp). Reasons to do this are:
It is possible to run the router outside the default bundled web server (Hyper).

* You have an existing web server stack that you wish to integrate with.
* You have very high performance requirements and you want to avoid the hit of dynamic configuration.
* You have particular configuration management requirements that are not currently catered for.
* You have something highly custom that you want to do.
## Reasons to avoid this

* Router APIs are not stable. You will effectively be making a fork of the Router.
* You will lose hot-reload, telemetry, configuration and Apollo Studio support.
* Managing lifecycle is hard, re-creating a good configuration and validation experience will be lots of work.
* We will be looking at increasing the capability of the plugin system over time.
* We will be looking to support multiple deployment platforms over time.

We don't have a compatibility matrix between the router and other libraries, so do expect incompatibilities.
## Reasons to consider this

* You have an existing web server stack that you wish to integrate with.
* You have particular configuration management requirements that are not currently catered for.
* You have something highly custom that you want to do and are prepared to go it alone.

0 comments on commit 7aed9ee

Please sign in to comment.