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 fb77b9d commit 01136fb
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 16 deletions.
47 changes: 38 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## CronScheduler by Kiwi Commerce Ltd
## Magento 2 - Cron Scheduler by Kiwi Commerce

### Overview
- You can Easily setup cron job
Expand All @@ -9,7 +9,32 @@
- Find the actual load on CPU/Memory by cron job execution
- Automatically kill the long running job

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

1. Composer Installation
- 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-cron-scheduler`<br/>
- Make sure that composer finished the installation without errors.

2. Command Line Installation
- Backup your web directory and database.
- Download Cron Scheduler installation package from <a href="https://github.com/kiwicommerce/magento2-cron-scheduler/releases/download/v1.0.0/kiwicommerce-cron-scheduler-v100.zip">here</a>.
- Upload contents of the Cron Scheduler 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_CronScheduler`<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/extensions/magento2-cron-scheduler/" target="_blank">Kiwi Commerce</a>

## Features

Expand Down Expand Up @@ -48,11 +73,15 @@ You can analyze the actual time taken by each job on magento dashboard.

<img src="https://kiwicommerce.co.uk/wp-content/uploads/2018/05/cronscheduler_dashboard.png" height="250"/> <br/>

## 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-cron-scheduler/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:support@kiwicommerce.co.uk">Email Us</a>
- Have a look at our <a href="https://kiwicommerce.co.uk/docs/cron_scheduler/">documentation</a>

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

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

In case of further help, kindly create a <a href="https://github.com/kiwicommerce/magento2-cron-scheduler/issues">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-cron-scheduler",
"name": "kiwicommerce/module-cron-scheduler",
"description": "Magento 2 - Cron Scheduler",
"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-cron-scheduler"
}
],
"autoload": {
"files": [
"registration.php"
Expand All @@ -29,3 +24,4 @@
}
}
}

0 comments on commit 01136fb

Please sign in to comment.