fix(docs): First crack at 10 minute plan.

README.md

@@ -9,6 +9,78 @@ Explore your MongoDB.
 3. Run `npm install` to install dependencies
 4. Run `npm start` to launch
 
+## Modules
+
+The top level modules in this project are:
+
+<dl>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/">scout</a></dt>
+  <dd>
+    This repo which acts as the package that glues everything together.
+  </dd>
+    <dt><a href="https://github.com/10gen/scout/tree/dev/scout-brain">scout-brain</a></dt>
+  <dd>
+    Needs to be broken down into topic based models but for now, this is where
+    all the business logic code lives we want to share between modules running
+    in the browser, nodejs, or electron.
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-ui">scout-ui</a></dt>
+  <dd>
+    The default Ampersand.js single-page application people actually interact with.
+    The <a href="https://github.com/10gen/scout/blob/dev/scout-ui/src/models/with-scout.js">WithScout</a> mixin
+    connects the <a href="https://github.com/10gen/scout/tree/dev/scout-ui/src/models">models</a> to
+    <a href="https://github.com/10gen/scout/tree/dev/scout-client">scout-client</a>.
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-client">scout-client</a></dt>
+  <dd>
+    Provides a clean API for <a href="https://github.com/10gen/scout/tree/dev/scout-server">scout-server</a>
+    that works in the browser, nodejs, or electron.
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-server">scout-server</a></dt>
+  <dd>
+    An express.js application which provides REST and socket.io connectivity
+    to the mongodb node.js driver.
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-electron">scout-electron</a></dt>
+  <dd>
+    Tooling for working with electron.  Also provides progressive enhancement
+    for scout when running inside an electron instance (e.g. OS menu bindings,
+    window management, breakpad, autoupdates).
+  </dd>
+</dl>
+
+### Other Modules
+
+<dl>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-check">scout-check</a></dt>
+  <dd>
+    Linting, dependency checking, and more.  Move to <code>mongodb-js/gulp-mj-check</code>
+  </dd>
+    <dt><a href="https://github.com/10gen/scout/tree/dev/scout-data">scout-data</a></dt>
+  <dd>
+    An experiment for providing some datasets on-board the app to populate
+    a bundled mongodb with.
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-landing-page">scout-landing-page</a></dt>
+  <dd>
+    A <a href="http://www.metalsmith.io/">metalsmith</a> static site to use
+    for building Scout's landing page. Move to <code>mongodb-js/scout-landing-page</code>
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-style">scout-style</a></dt>
+  <dd>
+    All of the base LESS, icons, and fonts <a href="https://github.com/10gen/scout/tree/dev/scout-ui">scout-ui</a>
+    and <a href="https://github.com/10gen/scout/tree/dev/scout-landing-page">scout-landing-page</a> use.
+    Move to <code>mongodb-js/scout-style</code> so design team can completely
+    own this.
+  </dd>
+  <dt><a href="https://github.com/10gen/scout/tree/dev/scout-metrics">scout-metrics</a></dt>
+  <dd>
+    An experiment we should just kill off when we start on mixpanel/intercom tickets.
+  </dd>
+</dl>
+
+
+
 [setup-osx]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#osx-setup
 [setup-windows]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#windows-setup
 [setup-linux]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#linux-setup

scout-check/index.js

@@ -73,6 +73,7 @@ module.exports = function(gulp, src) {
 
 
   // @todo: npm-check-updates
+  // @todo: https://www.npmjs.com/package/nsp-gulp
   gulp.task('check', ['format', 'lint', 'check dependencies']);
 };