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('') +.then(function (markdown) { + console.log(markdown); //=> Markdown content of medium post +}); +```