Initial commit

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b057bee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Sunday Corner
+
+This is a tiny CGI script to host an ephermeral microblog -- make your random
+thoughts from the week avaialable on your website for one day on Sunday.
+
+## Installing the CGI script
+
+Install it as you would any other Ruby CGI script on your webserver. Idk how to
+do it in every configuration, but here's how I did it on my Nginx setup:
+
+### Nginx
+
+    location /sunday.html {
+        include fastcgi_params;
+        fastcgi_param       SCRIPT_FILENAME <path to sunday.rb>;
+        fastcgi_pass        unix:/run/fcgiwrap.socket;
+    }
+
+Make sure sunday.rb is executable by your webserver process (e.g. by running
+`chmod a+x sunday.rb`).
+
+## Thinking thoughts
+
+This one is hard.
+
+## Adding thoughts
+
+This one is easy!
+
+At it's simplest, just point `THOUGHTS_DIR` in sunday.rb to a directory where
+you will manually create thoughts files. A thoughts file's filename is the date
+of the Sunday on which it will be displayed (in YYYY-MM-DD format). Its contents
+are your thoughts throughout the week, separated by newlines.