Verified Commit e7d221e4 authored by Luc Didry's avatar Luc Didry
Browse files

Add doc to README

parent 6fb92a3b
......@@ -4,6 +4,15 @@ This program creates an HTML statistics page from [`vrms`](https://packages.debi
This programm connects to an IMAP account, checks the new mails, parse them and create an HTML output in `public` folder.
## How to get `vrms` mails?
Install `vrms` on your computer, then simply create a cron task for:
vrms | mail -s "subject"
Then use the credentials for that email address with this software.
## How to use it on your computer?
### Installation
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment