jeffemmett
/
medium-to-markdown
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme with command line usage

This commit is contained in:
almenon 2019-12-22 15:17:38 -08:00
parent 40db2ef3d8
commit 65592f24c2
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,7 +3,27 @@
This module lets you take a medium post and convert it to markdown. This module lets you take a medium post and convert it to markdown.
### Usage ### Command Line Usage
**Setup:**
1. Install npm if not already installed
2. Clone the repo
3. run `npm install` inside the repo
**Outputting to command line:**
`npm run convert https://medium.com/@almenon214/keeping-yourself-motivated-as-a-coder-a16a6fcf49c7`
Replace the link with the article you want to convert.
**Outputting to file:**
`npm run convert https://medium.com/@almenon214/keeping-yourself-motivated-as-a-coder-a16a6fcf49c7 > exampleOutput.md`
Replace the link with the article you want to convert.
### API Usage
Currently, the module supports getting the markdown from a medium post by URL. Currently, the module supports getting the markdown from a medium post by URL.