summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorprzemyslawpluta <przemekpluta@hotmail.com>2014-03-06 19:04:47 +0000
committerprzemyslawpluta <przemekpluta@hotmail.com>2014-03-06 19:04:47 +0000
commitd172219d1bbe4df47bf2647646c3bb598cfdbd1e (patch)
tree4a2bba38fea03c91b039771416242d7f93ee3bc8
parent4dcc0dafad8ce8d54a8e8ca3d312e84719957f19 (diff)
downloadmongo-edu-d172219d1bbe4df47bf2647646c3bb598cfdbd1e.zip
add extended explainer
-rw-r--r--README.md26
-rw-r--r--mongo-edu.js2
2 files changed, 21 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1987a93..cad09db 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,7 @@ mongo-edu
[![NPM version](https://badge.fury.io/js/mongo-edu.png)](http://badge.fury.io/js/mongo-edu)
[![Dependency Status](https://gemnasium.com/przemyslawpluta/mongo-edu.png)](https://gemnasium.com/przemyslawpluta/mongo-edu)
-Select and download video courses from [education.mongodb.com](https://education.mongodb.com)
-
-![screenshot](https://raw.github.com/przemyslawpluta/mongo-edu/gh-pages/images/me.gif)
+Select and download videos and handouts from [education.mongodb.com](https://education.mongodb.com) courses
##Prerequisite
@@ -22,15 +20,31 @@ py 2.7 or 3.x
npm install mongo-edu -g
```
+## Select and download
+
+### Videos
+
+As long as the video lists are present in the wiki pages you can download all videos listed on a page for any given week.
+
+![screenshot](https://raw.github.com/przemyslawpluta/mongo-edu/gh-pages/images/ev.gif)
+
+### Handouts
+
+`-h` As long as the handouts lists are present in the wiki pages you can download all handouts listed on a page for any given week.
+
+![screenshot](https://raw.github.com/przemyslawpluta/mongo-edu/gh-pages/images/eh.gif)
+
+
##Usage
```
-mongo-edu -u [user name] -d [download path] --ncc [no check certificate]
+mongo-edu -d [download path] -u [user name] -h [get handouts] --ncc [no check certificate]
Options:
- -d download path [required]
+ -d download path [required]
-u email address
- --ncc no check certificate py3.x
+ -h switch from videos (default) to handouts
+ --ncc no check certificate with py3.x
```
##License
diff --git a/mongo-edu.js b/mongo-edu.js
index 0ea3468..e35640e 100644
--- a/mongo-edu.js
+++ b/mongo-edu.js
@@ -12,7 +12,7 @@ var mdbvideos = require('./lib/login'),
colors = require('colors'),
inquirer = require('inquirer'),
argv = require('optimist')
- .usage('Usage: $0 -u [user name] -d [download path] --ncc [no check certificate] -h [get handouts]')
+ .usage('Usage: $0 -d [download path] -u [user name] -h [get handouts] --ncc [no check certificate]')
.describe('d', 'download path').describe('u', 'email address')
.describe('h', 'switch from videos (default) to handouts').boolean('h')
.describe('ncc', 'no check certificate with py3.x').boolean('ncc')