From 159002331ed3c0d177e36c86d0dd0874a6d061a1 Mon Sep 17 00:00:00 2001
From: Tait Hoyem <tait@tait.tech>
Date: Wed, 19 Jan 2022 13:33:22 -0700
Subject: [PATCH] Add readme for ccon

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

diff --git a/ccon/README.md b/ccon/README.md
new file mode 100644
index 0000000..da58cc3
--- /dev/null
+++ b/ccon/README.md
@@ -0,0 +1,24 @@
+# ccon
+
+`ccon` is a currency converter.
+It uses the standard "units" utility.
+Once installed via the `units` package in most repositories, you may use `ccon` to avoid some of the weird syntaxes used by `units`.
+After installing `units`, run the `units_cur` command to get a current table of currency conversions.
+You may want to occasionally run `units_cur` again just to make sure you're up to date.
+
+To use this script, use the following format: `ccon <number of base currency> <base currency> <currency to convert to>`; examples:
+
+```bash
+$ ccon 1 USD CAD
+1.25
+$ ccon 1 CAD USD
+0.80
+$ ccon 1 CAD TWD
+22.08
+$ ccon 52 AUD GBP
+27.48
+$ ccon 22.37 USD NZD
+33.03
+```
+
+Have fun!