From 6916a67af5aa5266306afd348bc843d16f2a2130 Mon Sep 17 00:00:00 2001 From: Peter Valdez Date: Tue, 4 Jun 2024 02:54:47 -0400 Subject: [PATCH] Update the project description --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae90415..47e1a86 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,11 @@ # Snorlax ยท [![Build Docker image](https://github.com/moonbeam-nyc/snorlax/actions/workflows/build-docker-image.yaml/badge.svg)](https://github.com/moonbeam-nyc/snorlax/actions/workflows/build-docker-image.yaml) -Snorlax is a Kubernetes operator that wakes and sleeps a set of Kubernetes deployments on a schedule. +Snorlax is a Kubernetes operator that wakes and sleeps a specified set of Kubernetes deployments on a schedule. -If you specify ingresses, they are updated to serve a wake proxy which serves a "sleeping" splash page and wakes the deployments up. +You can also specify ingresses which will be updated to point to a wake proxy when asleep. This serves a "sleeping" splash page and wakes the deployments up. Once the deployments are ready, the ingresses are restored and the splash page will auto-refresh. -You create `SleepSchedule` resources to define the schedule for deployments (and optionally their respective ingresses). - ## Why Snorlax?