add README.md

This commit is contained in:
David Tesler 2017-04-28 17:40:40 -07:00
parent 9505d1a214
commit bcbde2801f
1 changed files with 16 additions and 0 deletions

16
README.md Normal file
View File

@ -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
});
```