Skip to content

Commit 6264fa0

Browse files
committed
Minimal setup instructions
1 parent 68d215e commit 6264fa0

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,29 @@
22

33
En Elixir based built-in error tracking solution.
44

5-
## Installation
5+
## Configuration
66

7-
The package can be installed
8-
by adding `error_tracker` to your list of dependencies in `mix.exs`:
7+
Set up the repository:
98

109
```elixir
11-
def deps do
12-
[
13-
{:error_tracker, "~> 0.1.0"}
14-
]
10+
config :error_tracker,
11+
repo: MyApp.Repo
12+
```
13+
14+
Attach to Oban events:
15+
16+
```elixir
17+
defmodule MyApp.Application do
18+
def start(_type, _args) do
19+
ErrorTracker.Integrations.Oban.attach()
20+
end
1521
end
1622
```
1723

24+
Attach to Plug errors:
25+
26+
```elixir
27+
defmodule MyApp.Endpoint do
28+
use ErrorTracker.Plug
29+
end
30+
```

0 commit comments

Comments
 (0)