From e566b2e956085aeac3131f0c7a2cc4a9886cd9fb Mon Sep 17 00:00:00 2001 From: Alek Ratzloff Date: Thu, 22 Sep 2022 10:12:02 -0700 Subject: [PATCH] Update README with usage instructions Signed-off-by: Alek Ratzloff --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b42b4e..1c41f3f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # markup -A small, easy markup language for doing basic replacements in text. \ No newline at end of file +A small, easy markup language for doing basic replacements in text. + +# Usage + +If you want to use it inside of Python, you should be able to just drop in `markup.py` into your +Python program. + +If you want to use it on the command line, you can either call `./markup.py` and pass your text to +process through STDIN. Otherwise, you can pass in a (single) file as an argument, e.g. +`./markup.py filename.txt`