From c5acc86fd57d7fbdf416998438ec3402038c8e0d Mon Sep 17 00:00:00 2001
From: Yang-Le Wu <yangleuu@gmail.com>
Date: Mon, 25 Sep 2017 23:22:59 -0400
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6da1675
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# pandoc-eqref
+
+*pandoc-eqref* is a simple [pandoc][] [filter][] that in effect wraps all `\eqref{...}`
+and `\ref{...}` calls in `$...$`, so that they can be recognized and properly
+rendered by [MathJax][].
+
+Additionally, it also replaces the [non-breaking space][tilde] `~` in a few
+common LaTeX idioms by a simple space `0x20`.
+
+The module [`pandocfilters`][pf] is embedded as a git submodule to make it
+easier to embed *this* project as a submodule elsewhere.
+
+[pandoc]: http://pandoc.org/index.html
+[filter]: http://pandoc.org/scripting.html
+[MathJax]: https://www.mathjax.org/
+[tilde]: https://tex.stackexchange.com/a/41268
+[pf]: https://github.com/jgm/pandocfilters