Commit a587f491 authored by kimi's avatar kimi

update description and README

parent b617bee8
# µLetter # µLetter
**MuLetter** is a Command Line Interface newsletter for small mailing list **MuLetter** is a Command Line Interface newsletter for small mailing list
## Minimum requirements ## Requirements
- [Nodejs v4](https://nodejs.org) - [Nodejs v4](https://nodejs.org)
- A mailing list - SMTP server
## Install ## Install or Update
First of all, you must install `muletter` as a global module to create the `muletter` command on your system. First of all, you must install `muletter` as a global module to create the `muletter` command on your system.
...@@ -32,7 +32,7 @@ Example of `config.yml`: ...@@ -32,7 +32,7 @@ Example of `config.yml`:
letter_from: letter name <username@hostname.com> letter_from: letter name <username@hostname.com>
letter_subject: subject letter letter_subject: subject letter
If you use a smtp service included in [nodemailer-wellknown](https://github.com/nodemailer/nodemailer-wellknown) module you can simply fill `smtp_service` instead of 'smtp_host' and 'smtp_ssl': If you use a service included in [nodemailer-wellknown](https://github.com/nodemailer/nodemailer-wellknown) module you can simply fill `smtp_service` instead of 'smtp_host' and 'smtp_ssl':
smtp_user: username smtp_user: username
smtp_password: password smtp_password: password
......
{ {
"name": "muletter", "name": "muletter",
"version": "0.1.2", "version": "0.1.3",
"description": "CLI newsletter for small mailing list", "description": "CLI newsletter for SMTP",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/kimihub/muletter.git" "url": "git+https://github.com/kimihub/muletter.git"
......
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