Skip to content

Commit 8b76747

Browse files
authored
improve docs (#7)
1 parent 91257e1 commit 8b76747

File tree

4 files changed

+30
-10
lines changed

4 files changed

+30
-10
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# CHANGELOG
22

3+
## v1.3.1
4+
5+
* Improved README, no new features.
6+
37
## v1.3.0
48

59
* Add search.

README.md

+25-9
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,31 @@
22

33
<!-- MDOC !-->
44

5-
Real-time Monitoring for `Oban` with `Phoenix.LiveDashboard`.
5+
Obanalyze provides real-time monitoring for `Oban` within `Phoenix.LiveDashboard`,
6+
delivering a user-friendly interface to manage background jobs seamlessly.
67

7-
## Install
8+
## Features
9+
10+
- **Job Management**: Retry, cancel, or delete jobs directly from the dashboard.
11+
- **Filtering**: Filter jobs based on worker name or job arguments to quickly find what you're looking for.
12+
- **Database Compatibility**: Fully compatible with SQLite, PostgreSQL or any database that Oban uses.
13+
14+
## Installation
815

916
The package can be installed by adding `obanalyze` to your list of dependencies in `mix.exs`:
1017

1118
```elixir
1219
def deps do
1320
[
14-
{:obanalyze, "~> 1.0"}
21+
{:obanalyze, "~> 1.3"}
1522
]
1623
end
1724
```
1825

19-
## Configure
26+
## Configuration
2027

21-
Update the `live_dashboard` configuration in your router.
28+
Configure your application to include Obanalyze in `Phoenix.LiveDashboard`.
29+
Update your router configuration as follows:
2230

2331
```elixir
2432
# lib/my_app_web/router.ex
@@ -31,14 +39,22 @@ live_dashboard "/dashboard",
3139
]
3240
```
3341

34-
## Done
42+
## Usage
43+
44+
After installation and setup, navigate to your `Phoenix.LiveDashboard` at the specified
45+
route (e.g., `/dev/dashboard`). You will see the new `Obanalyze` tab, which provides
46+
a complete overview of your background jobs.
3547

36-
Go to your `Phoenix.LiveDashboard` and you should see the `Obanalyze` tab.
48+
## List view
3749

3850
![Obanalyze screenshot](doc/images/obanalyze.png "Obanalyze")
3951

52+
## Single job view
53+
54+
![Obanalyze job screenshot](doc/images/obanalyze_job.png "Single Job")
55+
4056

4157
# Alternatives
4258

43-
* [evilmarty/oban_live_dashboard](https://github.com/evilmarty/oban_live_dashboard) where I took my inspiration from.
44-
You should check it out if you want a simple way to observe your Oban jobs.
59+
- [evilmarty/oban_live_dashboard](https://github.com/evilmarty/oban_live_dashboard): Inspired this project; a simplistic approach to Oban job monitoring.
60+
- [Oban Web](https://getoban.pro): Official advanced dashboard offering extensive features, directly from the creators of Oban.

doc/images/obanalyze_job.png

407 KB
Loading

mix.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule Obanalyze.MixProject do
22
use Mix.Project
33

4-
@version "1.3.0"
4+
@version "1.3.1"
55
@source_url "https://github.com/egze/obanalyze"
66

77
def project do

0 commit comments

Comments
 (0)