add note on examples to readme

This commit is contained in:
almenon 2019-12-23 22:55:57 -08:00
parent 2e7c94c970
commit cd4cb1b116
1 changed files with 4 additions and 0 deletions

View File

@ -23,6 +23,10 @@ Replace the link with the article you want to convert.
Replace the link with the article you want to convert.
### What does the output look like?
See `examples/exampleOutput.md` for an example of what https://medium.com/@almenon214/keeping-yourself-motivated-as-a-coder-a16a6fcf49c7 looks like when converted to markdown.
### API Usage
Currently, the module supports getting the markdown from a medium post by URL.