add a bit of readme
This commit is contained in:
parent
ab0cfcf09a
commit
24e6422cc3
1 changed files with 21 additions and 0 deletions
21
README.md
21
README.md
|
@ -5,6 +5,27 @@ Dip
|
|||
|
||||
Configurable webhook server.
|
||||
|
||||
Set up some kind of directory structure like this:
|
||||
|
||||
```
|
||||
root/
|
||||
- config.toml
|
||||
- hooks/
|
||||
- website.com
|
||||
```
|
||||
|
||||
where every file in the `hooks` subdirectory is a TOML document of the following format:
|
||||
|
||||
```toml
|
||||
# The handler to use. This must match one of the handlers defined in the
|
||||
# handlers directory or one of the builtins such as "github"
|
||||
type = "github"
|
||||
|
||||
# wip lol
|
||||
```
|
||||
|
||||
Then run the `dip` binary with the option `-d <root>` where `root` points to the root directory you made above.
|
||||
|
||||
Contact
|
||||
-------
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue