Merge pull request #4 from dephraiim/github

feature: get readme from github repo

dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "termd",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "Render markdown files in the terminal",
     "repository": "dephraiim/termd",
     "main": "index.js",

index.ts

@@ -1,16 +1,17 @@
 #!/usr/bin/env ts-node
 import meow = require('meow');
 import renderMarkdown, { renderString } from './src/termd';
-import { getMarkdownFromUrl, npmPackageUrl } from './src/utils';
+import { getMarkdownFromUrl, githubReadmeUrl, npmPackageUrl } from './src/utils';
 
 const cli = meow(`
   Usage
     $ termd <filename>
 
   Options
-    --string, -s  Use a string with markdown syntax
-    --url, -u     Render markdown from url in the terminal
-    --npm, -n     Render npm package readme in the terminal
+    --string, -s    Use a string with markdown syntax
+    --url, -u       Render markdown from url in the terminal
+    --npm, -n       Render npm package readme in the terminal
+    --github, -g    Render github repository readme in the terminal
 
   Examples
     $ termd readme.md // # Heading 1
@@ -21,6 +22,9 @@ const cli = meow(`
     ${renderString('# Heading 1')}
     $ termd -n termd
     ...
+
+    $ termd --github="dephraiim/termd"
+    ...
 `);
 
 try {
@@ -52,6 +56,21 @@ try {
                 throw new Error(e);
             });
     }
+
+    if (cli.flags.g || cli.flags.github) {
+        let repoName = (cli.flags.github as string) || (cli.flags.g as string);
+        let repoUrl = githubReadmeUrl(repoName);
+        getMarkdownFromUrl(repoUrl)
+            .then((data) => data.content)
+            .then((data64) => {
+                let buffer = Buffer.from(data64, 'base64');
+                return buffer.toString('utf-8');
+            })
+            .then((readme) => console.log(renderString(readme)))
+            .catch((e) => {
+                throw new Error(e);
+            });
+    }
 } catch (error) {
     console.log(error.message);
 }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "termd",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "Render markdown files in the terminal",
     "repository": "dephraiim/termd",
     "main": "index.js",

src/utils.ts

@@ -70,3 +70,8 @@ export const npmPackageUrl = (packageName: string): string => {
 
     return NPM_REGISTRY + packageName;
 };
+
+export const githubReadmeUrl = (repoName: string): string => {
+    const GITHUB_URL = `https://api.github.com/repos/${repoName}/readme`;
+    return GITHUB_URL;
+};