Merge branch 'master' of github.com:chrisgreg/timebomb

chrisgreg · May 21, 2021 · d6bc17d · d6bc17d
2 parents c8b9f8d + 6408b34
commit d6bc17d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,16 @@ ETS backed delayed action scheduler written in Elixir & Erlang.
 
 Ever wanted to implement something like how UberEats and Deliveroo ping you with a notification if you don't checkout after X time?
 
+## Example usage:
+
+```elixir
+  timed_function = IO.inspect("BOOM")
+  Timebomb.spark(fuse: 10_000, bomb: timed_function)
+
+  ...10 seconds later
+  BOOM
+```
+
 ## TODO:
 - Tests
 - Publish on Hex