From bcbde2801f33b0c437e407b4bc71f262b1e5f585 Mon Sep 17 00:00:00 2001
From: David Tesler <david@tesler.com>
Date: Fri, 28 Apr 2017 17:40:40 -0700
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aafdbde
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Medium to markdown
+
+This module lets you take a medium post and convert it to markdown.
+
+### Usage
+
+Currently, the module supports getting the markdown from a medium post by URL.
+
+```javascript
+const mediumToMarkdown = require('medium-to-markdown');
+
+mediumToMarkdown.convertFromUrl('<medium post url>')
+.then(function (markdown) {
+  console.log(markdown); //=> Markdown content of medium post
+});
+```