Commit e82abd81 authored by kimi's avatar kimi

add cli help and update dependencies

parent 8672c25b
......@@ -29,7 +29,7 @@ Example of `config.yml`:
smtp_password: password
smtp_host: smtp.hostname.com
smtp_ssl: true
letter_from: letter title <username@hostname.com>
letter_from: letter name <username@hostname.com>
letter_subject: subject letter
......@@ -63,8 +63,8 @@ Example of `list.txt`:
Usage: muletter [options] [command] [argument]
Commands
init Check config.yml list.txt body.txt attachments
test <email> Send a letter test to <email>
send Send the letter
test <email> Send the letter to <email>
send Send the letter to list.txt
help [command] Output usage information of [command]
[...]
'use strict';
const description = require('./package').description;
const version = require('./package').version;
module.exports.main = `
Usage: muletter [options] [command] [argument]
${description}
Commands
init Check config.yml list.txt body.txt attachments
test <email> Send the letter to <email>
send Send the letter to list.txt
help [command] Output usage information of [command]
Options
-h, --help Output usage information
-V, --version Output the version number
Required files
config.yml
body.(txt|html)
list.txt
Optional attachments
attachments/*.*
`;
module.exports.init = `
Usage: muletter init
Check if all parameters are defined in config.yml, if body.(txt|html), list.txt exist and get all attachments
Example of config.yml
smtp_user: username
smtp_password: password
smtp_host: smtp.hostname.com
smtp_ssl: true
letter_from: letter name <username@hostname.com>
letter_subject: subject letter
`;
module.exports.test = `
Usage: muletter test <email>
Send the letter to <email>
`
module.exports.send = `
Usage: muletter send
Send the letter test to list.txt
`
module.exports.version = version;
......@@ -30,10 +30,12 @@
"mulist": "muletter.js"
},
"engines": {
"node": ">= 4.0.0",
"npm": ">= 3.0.0"
"node": ">= 4.0.0"
},
"dependencies": {
"commander": "^2.9.0"
"emailjs": "^1.0.8"
},
"devDependencies": {
"maildev": "^0.14.0"
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment