From b0f6a6b2ab4e7eb3f1d59161106e1f4cee39fc37 Mon Sep 17 00:00:00 2001 From: BuildTools Date: Mon, 2 Oct 2017 08:47:01 +0200 Subject: readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index a46666b..e3470f1 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ # markdown-viewer + +markdown-viewer is a Node.js application which display markdown files from the specified directory (md by default, can also be a symlink). Files are converted into HTTP pages with github style. + +## To run +``` +git clone https://github.com/Titely/markdown-viewer.git +cd markdown-viewer +``` +Here you will need to create the `md` directory or link where will be stored your .md files. Then: +``` +npm install +npm start +``` -- cgit v1.2.3