docs: add readme

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e34a379
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Unified Standard Format Markers to Gemtext
+
+This project converts usfm, used by bible translators, into gemtext, for your reading pleasure.
+
+## Usage
+
+```sh examples of how to use this
+# Convert Romans from the Open English Bible into a local gemtext file
+curl https://raw.githubusercontent.com/openenglishbible/Open-English-Bible/master/artifacts/us-release/usfm/45-Romans.usfm | ./usfm2gmi.py > romans-oeb.gmi
+
+# View an outline to the book of Matthew
+wget https://github.com/openenglishbible/Open-English-Bible/raw/master/artifacts/us-release/usfm/40-Matthew.usfm
+grep '\\\\s' 40-Matthew.usfm | ./usfm2gmi.py
+# View paragraphs with a footnote, highlighted
+./usfm2gmi.py < 40-Matthew.usfm | grep '\[.*\]'
+```
+
+## Links
+
+=> LICENSE.gmi Licensed under AGPLv3
+
+=> usfm2gmi.py View source code
+
+=> https://ubsicap.github.io/usfm/ Read the USFM documentation