Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshfng committed Sep 7, 2024
1 parent 74b7abb commit a928e43
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 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)
2 changes: 0 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: "3"

networks:
development:
test:
Expand Down

0 comments on commit a928e43

Please sign in to comment.