From 149331223e77aaaffe936f994205e1b4e784cdf2 Mon Sep 17 00:00:00 2001 From: sunnysideup Date: Tue, 3 Jan 2017 14:05:02 +1300 Subject: [PATCH] PATCH: module clean-up --- README.md | 72 +++++++++++++++++++++++++++++++++ tests/EcommerceDeliveryTest.php | 13 ++++++ 2 files changed, 85 insertions(+) create mode 100644 README.md create mode 100644 tests/EcommerceDeliveryTest.php diff --git a/README.md b/README.md new file mode 100644 index 0000000..efc1c61 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# Silverstripe ecommerce delivery module +[![Build Status](https://travis-ci.org/sunnysideup/silverstripe-ecommerce_delivery.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-ecommerce_delivery) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-ecommerce_delivery/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-ecommerce_delivery/?branch=master) +[![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-ecommerce_delivery/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-ecommerce_delivery?branch=master) +![helpfulrobot](https://helpfulrobot.io/sunnysideup/ecommerce_delivery/badge) + +[![Latest Stable Version](https://poser.pugx.org/sunnysideup/ecommerce_delivery/version)](https://packagist.org/packages/sunnysideup/ecommerce_delivery) +[![License](https://poser.pugx.org/sunnysideup/ecommerce_delivery/license)](https://packagist.org/packages/sunnysideup/ecommerce_delivery) +[![Monthly Downloads](https://poser.pugx.org/sunnysideup/ecommerce_delivery/d/monthly)](https://packagist.org/packages/sunnysideup/ecommerce_delivery) + + +## Documentation + + + + * [Developer Docs](docs/en/INDEX.md) + * [User Guide](docs/en/userguide.md) + * [API](http://ssmods.com/apis/ecommerce_delivery/docs/en/api/) + +## Requirements + + + +see [composer.json](composer.json) for details + +### Suggested Modules + + + +see [composer.json](composer.json) for details + + +## Installation + + +``` +composer require sunnysideup/ecommerce_delivery +``` + +### Configuration + + + +In the `_config` folder you will find the `ecommerce_delivery.yml.example` +file that shows options for the configuration of this module. + +We recommend that you: + + 1. copy these `ecommerce_delivery.yml.example` files into your +`mysite/_config` folder + 2. remove the .example extension + 3. delete the lines you not care about, and + 4. adjust the configurations that you would like to use. + + +## Contributing + + + +We welcome any contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. + +## Paid assistance + + + +You can pay us to create an improved / adapted version of this module for your own projects. Please contact us if you like to find out more: [www.sunnysideup.co.nz](http://www.sunnysideup.co.nz) + +## Author + + + +Sunny Side Up Ltd. diff --git a/tests/EcommerceDeliveryTest.php b/tests/EcommerceDeliveryTest.php new file mode 100644 index 0000000..875576b --- /dev/null +++ b/tests/EcommerceDeliveryTest.php @@ -0,0 +1,13 @@ +assertEquals(1, 1); + } + +} +