summaryrefslogtreecommitdiff
path: root/paper/lua-filters/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'paper/lua-filters/README.md')
-rw-r--r--paper/lua-filters/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/paper/lua-filters/README.md b/paper/lua-filters/README.md
new file mode 100644
index 0000000..736ed8f
--- /dev/null
+++ b/paper/lua-filters/README.md
@@ -0,0 +1,21 @@
+[![travis build
+status](https://img.shields.io/travis/pandoc/lua-filters/master.svg?label=travis+build)](https://travis-ci.org/pandoc/lua-filters)
+
+# Lua Filters
+
+This repository collects Lua filters for pandoc.
+
+To learn about Lua filters, see the
+[documentation](http://pandoc.org/lua-filters.html).
+
+Each filter goes in its own subdirectory. Each subdirectory contains:
+
+- the filter itself (e.g. `wordcount.lua`)
+- a `README.md` describing the use of the filter
+- a `Makefile` with a `test` target to test the filter
+- some data files used for the tests, which may also serve
+ as examples
+
+PRs for new filters are welcome, provided they conform to
+these guidelines.
+