From 65592f24c230bed6ff4569a6b0f3c8df0b9c4f71 Mon Sep 17 00:00:00 2001 From: almenon Date: Sun, 22 Dec 2019 15:17:38 -0800 Subject: [PATCH] updated readme with command line usage --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 918d3d9..1cb1de7 100644 --- a/README.md +++ b/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.