From 650cdb8bc79ec174e592262fb9665df6c1f02b3c Mon Sep 17 00:00:00 2001 From: joshfng <121190566+joshfng@users.noreply.github.com> Date: Fri, 6 Sep 2024 19:54:16 -0400 Subject: [PATCH] Update README --- README.md | 18 ++++++++++++++++-- docker-compose.yml | 2 -- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4ed1c89..a5ffaff 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # Detonate -[![CI](https://github.com/suspiciousmilk/detonate/actions/workflows/ci.yml/badge.svg)](https://github.com/suspiciousmilk/detonate/actions/workflows/ci.yml) +[![CI](https://github.com/joshfng/detonate/actions/workflows/ci.yml/badge.svg)](https://github.com/joshfng/detonate/actions/workflows/ci.yml) -A software Dead Man's Switch to release information to the public +> A dead man's switch is a switch that is designed to be activated or deactivated if the human operator becomes incapacitated, such as through death, loss of consciousness, or being bodily removed from control[^1] + +Detonate is a software dead man's switch[^2] designed to activate if an operator becomes unresponsive + +Detonate encrypts and stores valuable information and checks in with at a configurable interval. If the operator fails to check in with a heartbeat a configurable number of times, the valuable information is released to a configured list of recipients. + +## TODO + +- Improve README/better documentation/getting started +- More ways to send and acknowledge heartbeats (incoming webhooks, sms, chat apps) +- More than text based info storage (encrypted file storage, videos, audio) +- More ways to expose the information when detonating besides just emailing it out (publish to external platforms/blogs/social media, sms, chat apps, rss, even physical mailings) + +[^1]: [https://en.wikipedia.org/wiki/Dead_man%27s_switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch) +[^2]: [https://en.wikipedia.org/wiki/Dead_man%27s_switch#Software](https://en.wikipedia.org/wiki/Dead_man%27s_switch#Software) diff --git a/docker-compose.yml b/docker-compose.yml index 2ac2b48..d560828 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,3 @@ -version: "3" - networks: development: test: