alps/README.md
2019-12-09 16:05:40 +01:00

26 lines
624 B
Markdown

# 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