1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1447de7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+## Description
+
+Terminus is a program intended for more technically-inclined people (especially
+avid Linux terminal users) who have thoroughly secured their data but still
+want a way for their loved one(s) to gain access to it in the event of their
+untimely demise.
+ 
+
+## How it works
+
+The intent for terminus is to be placed inside a user's shell's rc file (eg:
+bashrc, zshrc, etc). This way, every new shell will execute terminus and
+continually update the last login time. However, terminus can also be scheduled
+to run with a scheduler, or any other way to trigger its consistent execution.
+
+If the user account has been logged into more recently than the given threshold
+(a day count), then terminus exits (now - lastlogin < threshold).
+
+If the account has not been logged into within the threshold of time specified
+at execution (now - lastlogin > threshold), the next login will execute the
+given command
+
+The command to be executed can be anything. If multiple commands need to be
+executed, they can be chained together with quotes, or even better, written
+into a script that terminus will call.
+
+**Note** that commands are executed within a subshell that contains the same
+environmental variables as the shell terminus is running within.
+
+
+## Usage
+
+    terminus <days> <command_to_execute>
+
+
+### Example 0
+
+    terminus 7 "decrypt_passwords.sh"
+
+This command would execute the *decrypt_passwords.sh* script if the user has
+not logged in within the last 7 days.
+
+
+### Example 1
+
+    terminus 5 "cat ~/Documents/lovenote.txt && mplayer ~/Music/red_is_the_rose.ogg"
+
+This command would print a love note to the terminal and play a song afterwards, provided the user has not logged in within 5 days.