diff --git a/packages/router/README.md b/packages/router/README.md index 7ed7594c2..236f1a476 100644 --- a/packages/router/README.md +++ b/packages/router/README.md @@ -24,6 +24,10 @@ In your `router.js` file, import our router instead of the stock one: +import EmberRouter from '@embroider/router'; ``` +## Notes on usage with pods + +If you use the pod file layout for your routes, you have to make sure to set a non-undefined `podModulePrefix` in your `config/environment.js`. `podModulePrefix: ''` is also allowed. Otherwise, your pod routes will not be picked up by Embroider. + ## License This project is licensed under the [MIT License](LICENSE.md).