Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notes to improve performance #116

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add notes to improve performance #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,20 @@ If you share this file, it can be used by those who do not have a Ruby on Rails

It would be very smart to generate it automatically using CI.


#### Performance
For bigger rails applications, to avoid increasing app startup time, you can add `require: false` to the gemfile -
```
gem "rails-mermaid_erd", group: :development, require: false
```


And open the heavy mermaid_erd/index.html file in Google Chrome directly for more a responsive experience -
```
bundle exec ruby -r rails-mermaid_erd -S rails mermaid_erd && open -a "Google Chrome" mermaid_erd/index.html
```


## Configuration

`./config/mermaid_erd.yml` to customize the configuration.
Expand Down