Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rameerez committed Nov 8, 2024
1 parent 6777f2c commit 045ef20
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@

Add quick, simple, and beautiful health checks to your Rails application via a `/healthcheck` page.

Use it for smoke testing, to make sure your app is healthy and functioning as expected.

![Example dashboard of the Allgood health check page](allgood.jpeg)

## How it works

`allgood` allows you to define custom health checks (as in: can the Rails app connect to the DB, are there any new users in the past 24 hours, are they actually using the app, etc.) in a very intuitive way that reads just like English.
`allgood` allows you to define custom health checks / smoke tests (as in: can the Rails app connect to the DB, are there any new users in the past 24 hours, are they actually using the app, etc.) in a very intuitive way that reads just like English.

It provides a `/healthcheck` endpoint that displays the results in a beautiful page.

Expand Down

0 comments on commit 045ef20

Please sign in to comment.