Skip to content

Commit 8752f39

Browse files
committed
Add minimal README instructions
1 parent 3ff853e commit 8752f39

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

Diff for: README.md

+19-14
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
11
# EmailErrorReporter
2-
Short description and motivation.
32

4-
## Usage
5-
How to use my plugin.
3+
> [!CAUTION]
4+
> This is very early prototype
5+
6+
`email_error_reporter` uses the new [Rails error reporting API](https://guides.rubyonrails.org/error_reporting.html#error-reporting) to send emails whenever an exception is being reported. It works out of the box with HTTP requests, job errors and the rails runner errors.
67

78
## Installation
8-
Add this line to your application's Gemfile:
99

10-
```ruby
11-
gem "email_error_reporter"
12-
```
10+
Add the gem:
1311

14-
And then execute:
1512
```bash
16-
$ bundle
13+
bundle add email_error_reporter && bundle install
1714
```
1815

19-
Or install it yourself as:
20-
```bash
21-
$ gem install email_error_reporter
16+
and configure the email addresses that should receive an email in the case of an exception:
17+
18+
```ruby
19+
# application.rb
20+
config.email_error_reporter.to = ["youremail@example.com"]
2221
```
2322

24-
## Contributing
25-
Contribution directions go here.
23+
`email_error_reporter` will reuse your environment specific ActionMailer configuration for delivering emails.
24+
25+
## Usage
26+
27+
All exceptions are reported automatically. No additional code required.
28+
29+
Please consult the [official guides](https://guides.rubyonrails.org/error_reporting.html) for an introduction to the error reporting API.
2630

2731
## License
32+
2833
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)