Skip to content

Commit

Permalink
Add more detail to engine documentation (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
exterm authored Mar 15, 2024
1 parent 76782e6 commit 1be1086
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1be1086

Please sign in to comment.