aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 82cb9332d0e9061e6a1eacf3e8b74bab8d2406ff (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# koushin

## Usage

    go run ./cmd/koushin imaps://mail.example.org:993 smtps://mail.example.org:465

See `-h` for more information.

## Themes

They should be put in `public/themes/<name>/`.

Templates in `public/themes/<name>/*.html` override default templates in
`public/*.html`. Assets in `public/themes/<name>/assets/*` are served by the
HTTP server at `themes/<name>/assets/*`.

## Plugins

Lua plugins are supported. They can be dropped in `plugins/*.lua`.

For now only a single hook is supported: `render(name, data)`. If defined, this
Lua function will be called prior to rendering a template.

## License

MIT