Added README

3 files changed, 60 insertions, 7 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c11fdc0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,18 @@
+Copyright (c) 2013 Kevin Chabowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..efee8c6
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,21 @@
+# mailremind
+
+mailremind is a web-based service that sends you mails with a delay-
+
+## Why?
+
+I often send myself an email to remind me of something. If the event I want to be remindered of is in the not-so-close future this method does not work so well, since the mail is then not new any more. Also mailremind allows you to send mails repetetive based on a schedule, so it can be used for reoccurring events, like birthdays.
+
+## Installation
+
+Get the sources and build mailremind with `go build`.
+
+Or simply run `go get github.com/kch42/mailremind`. This will place the compiled binary in your `$GOPATH/bin` directory.
+
+## Configuration
+
+All config stuff is in the mailremind.ini file.
+
+## Running
+
+Simply run `./mailremind -config mailremind.ini` and mailremind will listen on the configured address (net.laddr) and handle http requests.
diff --git a/mailremind.ini b/mailremind.ini
index a4be249..59e9e2e 100644
--- a/mailremind.ini
+++ b/mailremind.ini
@@ -3,8 +3,9 @@ baseurl=http://localhost:8080
 
 [securecookies]
 # Both auth and crypt must only contain hexadecimal characters. For best security: 64 Hex chars
-auth=6e988360457b4f481a44a90515abeb53428aefdb6f99c34f23f631667b4542a8
-crypt=2a3b337386908b691e933f285b7b2f0b370abeed8e943fbd7be6d228d5fd6527
+# PLEASE DO NOT USE THE DEFAULT VALUES!
+#auth=0000000000000000000000000000000000000000000000000000000000000000
+#crypt=0000000000000000000000000000000000000000000000000000000000000000
 
 [net]
 laddr=:8080
@@ -15,16 +16,29 @@ tpls=tpls
 mailtpls=mails
 
 [db]
+# mysql is currently the only driver.
 driver=mysql
+# See https://github.com/go-sql-driver/mysql#dsn-data-source-name for valid conf options
 conf=mailremind:mailremind@tcp/mailremind
 
 [mail]
-method=sendmail
-addr=nobody@kch42.net
+addr=nobody@yourdomain
 parallel=10
-exec=msmtp
-arg1=-a
-arg2=kch42
+# You need to set the 'method' variable here. Possible values are:
+# sendmail
+#   mail will be sent using a sendmail-like program, that means it must...
+#     ...accept the from address with the -f option
+#     ...accept the to address as a parameter
+#     ...expect the mail on stdin (including all headers), terminated by EOF.
+#   The 'exec' variable determines the program to use.
+#   Optional the 'argX' variables can be used to provide additional parameters for the program. X is an ascending number, starting with 1.
+# smtp
+#   mails will be sent through an smtp server. These additional variables are needed:
+#     addr    - The address of the smtp server (go notation)
+#     user    - Username
+#     passwd  - Password
+#     crammd5 - Should CRAMMD5 (on) or PLAIN (off) be used?
+#     host    - The expected hostname of the mailserver (can be left out, if crammd5 is on)
 
 [schedules]
 # How often should the schedules be checked? Unit is seconds.