From 045ef20539c57c8852689192aa2eec22e63e17f8 Mon Sep 17 00:00:00 2001 From: Javi R <4920956+rameerez@users.noreply.github.com> Date: Fri, 8 Nov 2024 23:35:43 +0000 Subject: [PATCH] Update README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 44493cf..9d6157b 100644 --- a/README.md +++ b/README.md @@ -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.