Skip to content

Commit

Permalink
Add build badge and reach out section
Browse files Browse the repository at this point in the history
  • Loading branch information
azlyth committed May 29, 2024
1 parent 7c0e0d8 commit 9aec7d3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-docker-image.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Docker image
name: Docker image build

on:
push:
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="./proxy/static/logo-small.png" alt="Logo" width="300">
</div>

# Snorlax
# Snorlax · [![Build Docker image](https://github.com/moon-society/snorlax/actions/workflows/build-docker-image.yaml/badge.svg)](https://github.com/moon-society/snorlax/actions/workflows/build-docker-image.yaml)

Snorlax is a Kubernetes operator which wakes and sleeps another Kubernetes deployment on a schedule.

Expand Down Expand Up @@ -71,7 +71,7 @@ hours each night and on weekends, that means they'll sleep ~55% of the month.

## Other features

- **Ingress controller awareness**: Snorlax determines which ingress controller you're running so it can create the correct ingress routes
- **Ingress controller awareness**: Snorlax determines which ingress controller you're running so it can create the correct ingress routes for sleep.
## Try it yourself locally
Expand Down Expand Up @@ -105,4 +105,12 @@ make operator-run
- Add support for custom wake and sleep actions (e.g. hit a webhook on wake)
- Add support for cron-style schedules (e.g. `0 8 * * *`)
- Add button to manually wake up the deployment (instead of auto-waking on request)
- Custom image/gif for sleeping page
- Custom image/gif for sleeping page
## Reach out
Wondering how to best use Snorlax? Have questions or ideas for new features?
I'd love to hear, and maybe even build it! Reach out to me at:

<img src="./proxy/static/readme-email-address.png" alt="Contact" width="300">
Binary file added proxy/static/readme-email-address.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9aec7d3

Please # to comment.