mail-server - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "mail-server",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Modules to send an email",
@@ -5,0 +5,0 @@ "main": "app.js",

README.md

@@ -1,8 +0,21 @@
-# mail-server
+# Mail Server
 
-easy install `git clone https://github.com/alileza/mail-server.git && cd mail-server && npm install && npm start`
+This mail server build using NodeJS (coffeescript) currently only support using **[Mandrill](https://mandrill.com)**, the goal of this application is to support massive external communication such an E-mail, Messaging, & Push Notification. Roadmap of this service would include : (Queueing, Template Manager, & Monitoring)
 
-test the mail server
+### Installation
+```sh
+$ git clone https://github.com/alileza/mail-server.git
+$ cd mail-server
+$ npm install 
+$ npm start
+```
+### Test the mail server
+```sh
+curl -X  \ 
+POST  -H "Content-Type: application/json" \
+http://localhost:1312/send-mail -d \
+'{"to": "[e-mail]","subject": "Hello World !","template" : "hello-world"}'
+```
 
-`curl -X POST  -H "Content-Type: application/json" http://localhost:1312/send-mail -d '{"to": "[e-mail]","subject": "Hello World !","template" : "hello-world"}'`
-
+### Mail Client
+[NodeJS Mail Client](https://github.com/alileza/mail-client)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5371

increased by1.67%

Number of lines in readme file

22

increased by144.44%

Worsened metrics

Number of package files

8

decreased by-27.27%

No dependency changes