Skip to content

Commit

Permalink
Update composer.json and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kiwi-commerce committed Jun 9, 2018
1 parent dff0b3d commit 4a352aa
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 18 deletions.
50 changes: 39 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Enhanced SMTP by Kiwi Commerce
## Magento 2 - Enhanced SMTP by Kiwi Commerce

### Overview
- Delivering messages is an important and mandatory part of running an e-Commerce business. Magento sends hundreds and thousands of emails on daily basis. Reliability of the email sending process should be as stable as possible. All emails must be delivered to recipients without delays.
Expand All @@ -7,15 +7,40 @@
- This extension includes pre-configured settings for 25+ most popular SMTP providers.
- This extension provides you with a feature to track all sent emails by inserting email log.

Find More details on <a href="https://kiwicommerce.co.uk/extensions/magento2-enhanced-smtp/" target="_blank">Kiwi Commerce Ltd</a>
### **Installation**

1. Install using Composer
- Navigate to your Magento root folder<br />
`cd path_to_the_magento_root_directory`<br />
- Then run the following command<br />
`composer require kiwicommerce/module-enhanced-smtp`<br/>
- Make sure that composer finished the installation without errors.

2. Install manually
- Backup your web directory and database.
- Download Enhanced SMTP installation package from <a href="https://github.com/kiwicommerce/magento2-enhanced-smtp/releases/download/v1.0.0/kiwicommerce-enhanced-smtp-v100.zip">here</a>.
- Upload contents of the Enhanced SMTP Log installation package to your Magento root directory.
- Navigate to your Magento root folder<br />
`cd path_to_the_magento_root_directory`<br />
- Then run the following command<br />
`php bin/magento module:enable KiwiCommerce_EnhancedSMTP`<br />
- Log out from the backend and log in again.

- After install the extension, run the following command <br/>
`php bin/magento setup:upgrade`<br />
`php bin/magento setup:di:compile`<br />
`php bin/magento setup:static-content:deploy`<br />
`php bin/magento cache:flush`

Find More details on <a href="https://kiwicommerce.co.uk/docs/enhanced_smtp/" target="_blank">Kiwi Commerce</a>

## Where will it appear in the Admin Panel

- Go to **System > Enhanced SMTP by KiwiCommerce > Email Logs**. Here you can See the list of sent mail logs.

![Email Log](https://kiwicommerce.co.uk/docs/img/enhanced_smtp/email_log.png)

- By clicking **View** in each mail log, you can have a look at the mail through the eyes of your customers.
- By clicking on **View** option in each mail log, you shall get to view your mail like a customer.

![Email Popup](https://kiwicommerce.co.uk/docs/img/enhanced_smtp/email_popup.png)

Expand All @@ -32,12 +57,15 @@ This section is placed right under SMTP Configure Section.

![Advanced Configuration](https://kiwicommerce.co.uk/docs/img/enhanced_smtp/advanced-configuration-section.png)

## Documentation
## Contribution
Well unfortunately there is no formal way to contribute, we would encourage you to feel free and contribute by:

- Creating bug reports, issues or feature requests on <a target="_blank" href="https://github.com/kiwicommerce/magento2-enhanced-smtp/issues">Github</a>
- Submitting pull requests for improvements.

We love answering questions or doubts simply ask us in issue section. We're looking forward to hearing from you!

- Follow us <a href="https://twitter.com/KiwiCommerce">@KiwiCommerce</a>
- <a href="mailto:[email protected]">Email Us</a>
- Have a look at our <a href="https://kiwicommerce.co.uk/docs/enhanced_smtp/">documentation</a>

For more detail, please check the <a href="https://kiwicommerce.co.uk/docs/enhanced_smtp/" target="_blank">Documentation</a>.

## Issue Reporting.

Before doing issue reporting, please make sure you followed all <a href="https://kiwicommerce.co.uk/docs/issue_reporting_guidelines/" target="_blank">guidelines</a> properly.

In case of further help, kindly create a <a href="https://github.com/kiwicommerce/magento2-enhanced-smtp/issues" target="_blank">new issue here</a>.
10 changes: 3 additions & 7 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"name": "kiwicommerce/magento2-enhanced-smtp",
"name": "kiwicommerce/module-enhanced-smtp",
"description": "Magento 2 - Enhanced SMTP",
"type": "magento2-module",
"version": "1.0.0",
"license": [
"OSL-3.0"
],
"minimum-stability": "dev",
"authors": [
{
"name": "Kiwi Commerce Ltd",
Expand All @@ -14,12 +15,6 @@
"role": "Leader"
}
],
"repositories": [
{
"type": "git",
"url": "https://github.com/kiwicommerce/magento2-enhanced-smtp"
}
],
"autoload": {
"files": [
"registration.php"
Expand All @@ -29,3 +24,4 @@
}
}
}

0 comments on commit 4a352aa

Please sign in to comment.