Merge pull request #930 from mydea/fn/pods-route-splitting-docs

add note on route splitting with pods in readme
embroider-build · Oct 11, 2021 · e717ed9 · e717ed9
2 parents 1606237 + ebbcbe3
commit e717ed9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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).