Skip to content

Commit

Permalink
🎨 add screenshot to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KylePDavis committed Jul 29, 2015
1 parent c4724c7 commit 2e42a5a
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2e42a5a

Please sign in to comment.