From 2ae8c6cca8906457dfa86ad5e355fed9982a4de0 Mon Sep 17 00:00:00 2001 From: Thomas Maurice Date: Mon, 12 Feb 2024 17:31:40 +0100 Subject: [PATCH] doc(license+readme): updates license and readme --- LICENSE | 13 +++++++++++++ README.md | 8 +++++--- 2 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c93f45 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + + Copyright (C) 2004 Sam Hocevar + + Everyone is permitted to copy and distribute verbatim or modified + copies of this license document, and changing it is allowed as long + as the name is changed. + + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. You just DO WHAT THE FUCK YOU WANT TO. diff --git a/README.md b/README.md index 0f77ce0..dd1a208 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # mailout +![wtfpl](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-2.png) + This is a simple binary to handle your self hosted mail notification-sending machines. **this is not intended for human users** @@ -16,7 +18,7 @@ The plan is basically: * you have a view to expose the relevant key to use for opendkim ## Warning -I halfed assed that shit on an afternoon to suit my own needs, improvements will follow. +I halfed assed that shit on an afternoon to suit my own needs, improvements will follow, or not. ## Features @@ -30,7 +32,7 @@ I halfed assed that shit on an afternoon to suit my own needs, improvements will * Unpublish them to a DNS provider (currently only OVH) ## Requirements -* Postgres with a user +* A postgresql database with a properly configured user * Optionally an OVH account ### Dovecot @@ -66,4 +68,4 @@ providers: endpoint: ovh-eu ``` -pointing to your DB and you're good \ No newline at end of file +pointing to your DB/OVH account and you're good \ No newline at end of file