convert readme to nfo; relicense to 0bsdHEADmain

1 files changed, 28 insertions, 0 deletions

diff --git a/README.nfo b/README.nfo
new file mode 100644
index 0000000..3a78f06
--- /dev/null
+++ b/README.nfo
@@ -0,0 +1,28 @@
+┌──────────────────────────────────────────────────────────────┐
+│  D A I L Y   P O E M                       [ KRZ ]   krz.sh  │
+└──────────────────────────────────────────────────────────────┘
+
+WHAT
+  python program. requests a random poem from the poetrydb api and
+  emails it to a configured list of addresses.
+
+REQUIRES
+  python, and a way to send mail (e.g. mailutils on debian).
+
+RUN
+      git clone <REPO_URL>
+      cd daily-poem
+      pip install -r requirements.txt
+
+  edit main.py and set:
+  - sender_email: the from address
+  - recipient_emails: a list of to addresses
+  - smtp_server: smtp host, defaults to localhost
+
+  then:
+
+      python main.py
+
+┌──────────────────────────────────────────────────────────────┐
+│  krz.sh                                                      │
+└──────────────────────────────────────────────────────────────┘