updated readme with command line usage
This commit is contained in:
parent
40db2ef3d8
commit
65592f24c2
22
README.md
22
README.md
|
|
@ -3,7 +3,27 @@
|
|||
|
||||
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.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue