summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 3 insertions, 5 deletions
diff --git a/README b/README
index c632ee6..7818f5c 100644
--- a/README
+++ b/README
@@ -17,14 +17,12 @@ Useage:
SPELLING-RBEAD
The spelling ruby reader.
-spelling-rbead is the email reader for spelling-rbee. You can use it to read your email
-for a message that begins with the line spelling and that then follows the format for spelling-rbee.
-This a way to make .txts for spelling-rbee (however it is not the only way.)
+spelling-rbead is the email reader for spelling-rbee. It to reads your email
+for a message that has the word "Spelling:" in the subject and outputs the contents.
Dependencies:
ruby
ruby net/imap
-an existing file to write to
Useage:
-./spelling-rbead <server> <username> <password> <address who sent the list> <file to write to>
+./spelling-rbead <server> <username> <password> <address who sent the list> | <file>