From a5d9664a9264f45b088cc363331b391a40779b40 Mon Sep 17 00:00:00 2001
From: David Luevano Alvarado <david@luevano.xyz>
Date: Fri, 17 Feb 2023 01:06:26 -0600
Subject: finish testing and polishing, add readme

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 46 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e844e38..dcc978b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
-# pymdvar
-Python's Markdown extension to insert variables
+# pymdvar - Python-Markdown Variable extension
+
+Simple extension meant to be used to convert variables to their corresponding values. Works with environment variables too.
+
+It uses the `${variable}` syntax. For example, given `variable=value`, the following text:
+
+```md
+Foo ${variable} bar
+```
+
+Becomes:
+
+```html
+<p>Foo value bar</p>
+```
+
+## Install
+
+`pymdvar` can be installed via `pip`:
+
+```sh
+python -m pip install pymdvar
+```
+
+## Usage
+
+The basic usage requires a dictionary with the variables to be passed to the `VariableExtension`:
+
+```py
+>>> import markdown
+>>> from pymdvar import VariableExtension
+>>> markdown.markdown('foo *${test}* bar', extensions=[VariableExtension(variables={'test': 'value'})])
+'<p>foo <em>value</em> bar</p>'
+```
+
+if `enable_env=True` is passed, then it will read environment variables, too. Variables in `variables` take preference.
+
+Only `a-z`, `A-Z`, `_` and `0-9` characters are accepted.
+
+Passing the extension as a string is supported:
+
+```py
+>>> import markdown
+>>> markdown.markdown('foo *${test}* bar', extensions=['pymdvar'], extension_configs={'pymdvar': {'variables': {'test': 'value'}}})
+'<p>foo <em>value</em> bar</p>'
+```
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2