From 20a0aaf0d9012c7434a8389c9887e380d2feded2 Mon Sep 17 00:00:00 2001
From: epi052 <epibar052@gmail.com>
Date: Wed, 3 Oct 2018 19:37:33 -0500
Subject: [PATCH] added caeser cipher readme

---
 caeser_cipher/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 caeser_cipher/README.md

diff --git a/caeser_cipher/README.md b/caeser_cipher/README.md
new file mode 100644
index 0000000..86fef4f
--- /dev/null
+++ b/caeser_cipher/README.md
@@ -0,0 +1,27 @@
+# Simple Caeser Cipher [En,De]coder
+
+A simple implementation of a CLI tool to work with caeser ciphers.  The default implementation is ROT-13, but can be 
+adjusted for any offset.  Works on files and string arguments passed via CLI.  
+
+```bash
+python3 caeser.py
+
+usage: caeser.py [-h] [-d] [-o OFFSET] (-f FILE | -s STRING)
+caeser.py: error: one of the arguments -f/--file -s/--string is required
+``` 
+
+```bash
+python3 caeser.py -s "have you tried turning it off and on again?"
+unir lbh gevrq gheavat vg bss naq ba ntnva?
+```
+
+```bash
+python3 caeser.py -d -s "unir lbh gevrq gheavat vg bss naq ba ntnva?" 
+have you tried turning it off and on again?
+```
+
+```bash
+python3 caeser.py -s "have you tried turning it off and on again?" -o -4
+dwra ukq pneaz pqnjejc ep kbb wjz kj wcwej?
+```
+