From 9184b1c4767fb5b6401f98d0e59d119e3d053854 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philip=20M=C3=BCller?= Date: Mon, 11 Mar 2024 09:47:06 -0400 Subject: [PATCH] Add more detail to engine documentation It previously wasn't clear why you would make something an engine, as this project reimplements part of Rails::Engine's functionality anyway. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 797ca42..374fe68 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,12 @@ end ``` ### Making your Package an Engine -Add `engine: true` to your `package.yml` to make it an actual Rails engine ([read more about what this means here](https://guides.rubyonrails.org/engines.html)): +You can add `engine: true` to your `package.yml` to make it an actual [Rails engine](https://guides.rubyonrails.org/engines.html). + +It implicitly sets up a namespace for your pack and adds namespace isolation. + +You can then also use other functionality that engines provide, like per-pack routes, scoped url helpers, or a table name prefix. + ```yml # packs/my_pack/package.yml enforce_dependencies: true