Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgreg committed May 21, 2021
1 parent d6bc17d commit d72eb0e
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,6 @@ 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

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
Expand Down Expand Up @@ -59,6 +45,9 @@ Stopping a payload from firing
:ok
```

## TODO:
- Tests
- Publish on Hex

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
Expand Down

0 comments on commit d72eb0e

Please sign in to comment.