From 2e42a5aa71ca5de06540cf79b77741f1388dbe74 Mon Sep 17 00:00:00 2001 From: Kyle P Davis Date: Tue, 28 Jul 2015 22:51:15 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20add=20screenshot=20to=20README.m?= =?UTF-8?q?d?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 57e037c..2c7baa3 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,28 @@ # MongoDB Workbench -A UI for working with [MongoDB](http://www.mongodb.org) databases. +A UI for working with [MongoDB] databases. -Built using [AngularJS](https://angularjs.org) and [Electron](https://github.com/atom/electron). +Built using [AngularJS] and [Electron]. +![Collection Aggregate Screen] -# Build -```bash -git clone https://github.com/KylePDavis/mongodb-workbench.git -./epm install # wraps "npm" for "electron" modules -``` +# Get it -# Run +a) download a prebuilt binary from the [releases] page +b) build from source (manually) ```bash +git clone https://github.com/KylePDavis/mongodb-workbench.git +cd mongodb-workbench/ +npm install npm start ``` +[MongoDB]: https://www.mongodb.org +[AngularJS]: https://angularjs.org +[Electron]: https://github.com/atom/electron -# Test - -```bash -npm test -``` +[releases]: https://github.com/KylePDavis/mongodb-workbench/releases +[Collection Aggregate Screen]: https://KylePDavis.github.io/mongodb-workbench/img/screenshots/collection-aggregate.png