Updated docs

DOCUMENTATION.md

@@ -7,24 +7,16 @@ You can see below the API reference of this module.
 - **Object** `config`:
   - `key` (String): The Sendgrid API key.
 
-### `send(data, cb)`
+### `send(data)`
 Send an email.
 
 #### Params
 
-- **Object** `data`: An object containing the following fields:
- - `subject` (String): The email subject.
- - `from_email` (String): The `from` email.
- - `from_name` (String): The `from` name (optional).
- - `to_email` (String): The `to` email.
- - `bcc_email` (String): The `bcc` email.
- - `cc_email` (String): The `cc` email.
- - `to_name` (String): The `to` name (optional).
- - `template_id` (String): The SendGrid template id.
- - `substitutions` (Object): The template substitutions.
-
+- **Object** `data`: An object containing the message object sent to Sendgrid, as [documented here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/mail/USE_CASES.md).
 In the Bloggify config you will have to provide the following data:
 
  - `key` (String): The SendGrid key.
-- **Function** `cb`: The callback function.
+
+#### Return
+- **Promise** A promise resolving the result from Sendgrid.
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-17 Bloggify <[email protected]> (https://bloggify.org)
+Copyright (c) 2016-18 Bloggify <[email protected]> (https://bloggify.org)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,7 +10,11 @@
 ## :cloud: Installation
 
 ```sh
-$ npm i --save bloggify-sendgrid
+# Using npm
+npm install --save bloggify-sendgrid
+
+# Using yarn
+yarn add bloggify-sendgrid
 ```
 
 
@@ -53,26 +57,18 @@ There are few ways to get help:
 - **Object** `config`:
   - `key` (String): The Sendgrid API key.
 
-### `send(data, cb)`
+### `send(data)`
 Send an email.
 
 #### Params
 
-- **Object** `data`: An object containing the following fields:
- - `subject` (String): The email subject.
- - `from_email` (String): The `from` email.
- - `from_name` (String): The `from` name (optional).
- - `to_email` (String): The `to` email.
- - `bcc_email` (String): The `bcc` email.
- - `cc_email` (String): The `cc` email.
- - `to_name` (String): The `to` name (optional).
- - `template_id` (String): The SendGrid template id.
- - `substitutions` (Object): The template substitutions.
-
+- **Object** `data`: An object containing the message object sent to Sendgrid, as [documented here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/mail/USE_CASES.md).
 In the Bloggify config you will have to provide the following data:
 
  - `key` (String): The SendGrid key.
-- **Function** `cb`: The callback function.
+
+#### Return
+- **Promise** A promise resolving the result from Sendgrid.
 
 
 

package.json

@@ -40,4 +40,4 @@
   "dependencies": {
     "@sendgrid/mail": "^6.3.1"
   }
-}
+}