From 47d147c3573d5d655dcfe319856d0c1258417a3d Mon Sep 17 00:00:00 2001 From: Joe Biellik Date: Sun, 8 Nov 2015 16:16:54 +0000 Subject: [PATCH] Improve README --- .editorconfig | 2 +- README.md | 34 +++++++++++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index 300f61f..e4281f1 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,6 +8,6 @@ end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true -[{.eslintrc,*.json,*.yml,*.jade}] +[{.eslintrc,*.json,*.yml,*.jade,*.md}] indent_style = space indent_size = 2 diff --git a/README.md b/README.md index 12dc9f5..80e9cc1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # paste -Simple Node.js pastebin +[![License](https://img.shields.io/github/license/JoeBiellik/paste.svg)](http://opensource.org/licenses/MIT) +[![Release Version](https://img.shields.io/github/release/JoeBiellik/paste.svg)](https://github.com/JoeBiellik/paste/releases) +[![Dependencies](https://img.shields.io/david/JoeBiellik/paste.svg)](https://david-dm.org/JoeBiellik/paste) +[![Node.js Version](https://img.shields.io/badge/node.js-%3E=_0.11-red.svg)](https://nodejs.org/download/) + +Simple [Node.js](https://nodejs.org/) pastebin built with [Koa](http://koajs.com/), [MongoDB](https://www.mongodb.org/), [Jade](http://jade-lang.com/), [Bootstrap 4](http://v4-alpha.getbootstrap.com/) and [Prism.js](http://prismjs.com/). + +## Development +1. Clone this repo: + ```sh + git clone https://github.com/JoeBiellik/paste.git && cd paste + ``` + +2. Start the virtual machine and connect: + ```sh + vagrant up + vagrant ssh + ``` + +4. Install dependencies: + ```sh + npm install + ``` + +5. Start MongoDB: + ```sh + docker-compose up -d + ``` + +5. Start app and reload on change: + ```sh + npm run watch + ```