Skip to content

Add a small README entry #1

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

Merged
kulturbande merged 1 commit into from
Jan 18, 2026
Merged

Add a small README entry #1

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ Add the gem to your Gemfile and restart the application.
$ bundle add alchemy-solid_errors
```

Follow the installation instructions of [Solid Errors](https://github.com/fractaledmind/solid_errors?tab=readme-ov-file#installation).
You have to run the Solid Errors generator:

```shell
$ rails generate solid_errors:install
```

> [!NOTE]
> This will necessary configuration for production. The gem will only show the menu item if Solid Errors is enabled in the environment.
> If you want to use this gem in development, you have to add the configuration manually to your `config/environments/development.rb`.

## Release a new version

First, bump the version with [gem-release](https://bundler.io/guides/creating_gem.html#releasing-the-gem):
Expand Down