X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=honey;a=blobdiff_plain;f=README.md;fp=README.md;h=b9116db31704126fc8714df6c7f53c25b941c64f;hp=0000000000000000000000000000000000000000;hb=8cc10854903eef97a9c82a0e48c3ea791fb787e6;hpb=65394a399d32af71f028dc680df1b48af87c0215

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b9116db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Honey - a simple markdown processor
+
+While it aims to target everything listed in the
+[Github Flavored Markdown Spec](https://github.github.com/gfm/), it currently
+does just a little bit of markdown that is actively used for consxy projects.
+
+It parser markdown into weave-html style objects which can then be turned into
+strings using the weave library.
+
+Right now it supports a basic version of:
+
+* lists of one indentation
+* headings of either ATX or underline style
+* links
+* codefences
+* emphasis and strength
+
+## Usage
+
+See [the reference page](https://consxy.com/honey/reference.html) for more information,
+but in general there is a ```honey:parse``` method that takes a string representing
+the markdown.