Skip to content

Commit

Permalink
add example config to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
w3irdrobot committed Aug 17, 2024
1 parent 50acca4 commit bf96181
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

Simple nostr notification service.

## Example Config

The location of the config is expected to be in the location for your machine as defined in the
[`dirs` crate](https://docs.rs/dirs/latest/dirs/). On Linux, that will be `$HOME/.config/bullrun/config.toml`.
The config is a TOML file. An example is below.

```toml
# The npub to monitor and notify of events on
npub = "npub1kmgpttf3hzmpnfa9jrpu99tqr8x865r2m7mkwwcvfs7pazm6dnvq5c97vh"

# Special npubs that have live events you want to be notified about
event_npubs = [
# RHR
"npub10uthwp4ddc9w5adfuv69m8la4enkwma07fymuetmt93htcww6wgs55xdlq",
]
```

## Development

Ensure Rust and Cargo are installed. The easiey way to do that is using [rustup](https://rustup.rs/). Then run the development server.
Expand Down

0 comments on commit bf96181

Please sign in to comment.