From 9d6eac42c9c08079c5dd5e0e42cba945ef00fadc Mon Sep 17 00:00:00 2001 From: sunnysideup Date: Tue, 10 Jan 2017 13:37:30 +1300 Subject: [PATCH] PATCH: module clean-up --- docs/en/INDEX.md | 72 +++++++++++++++++++++++++++++++++++++++++++ docs/en/README.old.md | 72 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 144 insertions(+) create mode 100644 docs/en/INDEX.md create mode 100644 docs/en/README.old.md diff --git a/docs/en/INDEX.md b/docs/en/INDEX.md new file mode 100644 index 0000000..f5ce570 --- /dev/null +++ b/docs/en/INDEX.md @@ -0,0 +1,72 @@ +# Silverstripe dropdown2autocomplete module +[![Build Status](https://travis-ci.org/sunnysideup/silverstripe-dropdown2autocomplete.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-dropdown2autocomplete) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-dropdown2autocomplete/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-dropdown2autocomplete/?branch=master) +[![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-dropdown2autocomplete/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-dropdown2autocomplete?branch=master) +![helpfulrobot](https://helpfulrobot.io/sunnysideup/dropdown2autocomplete/badge) + +[![Latest Stable Version](https://poser.pugx.org/sunnysideup/dropdown2autocomplete/version)](https://packagist.org/packages/sunnysideup/dropdown2autocomplete) +[![License](https://poser.pugx.org/sunnysideup/dropdown2autocomplete/license)](https://packagist.org/packages/sunnysideup/dropdown2autocomplete) +[![Monthly Downloads](https://poser.pugx.org/sunnysideup/dropdown2autocomplete/d/monthly)](https://packagist.org/packages/sunnysideup/dropdown2autocomplete) + + +## Documentation + + + + * [Developer Docs](docs/en/INDEX.md) + * [User Guide](docs/en/userguide.md) + * [API](http://ssmods.com/apis/dropdown2autocomplete/docs/en/api/) + +## Requirements + + + +see [composer.json](composer.json) for details + +### Suggested Modules + + + +see [composer.json](composer.json) for details + + +## Installation + + +``` +composer require sunnysideup/dropdown2autocomplete +``` + +### Configuration + + + +In the `_config` folder you will find the `dropdown2autocomplete.yml.example` +file that shows options for the configuration of this module. + +We recommend that you: + + 1. copy these `dropdown2autocomplete.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/docs/en/README.old.md b/docs/en/README.old.md new file mode 100644 index 0000000..f5ce570 --- /dev/null +++ b/docs/en/README.old.md @@ -0,0 +1,72 @@ +# Silverstripe dropdown2autocomplete module +[![Build Status](https://travis-ci.org/sunnysideup/silverstripe-dropdown2autocomplete.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-dropdown2autocomplete) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-dropdown2autocomplete/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-dropdown2autocomplete/?branch=master) +[![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-dropdown2autocomplete/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-dropdown2autocomplete?branch=master) +![helpfulrobot](https://helpfulrobot.io/sunnysideup/dropdown2autocomplete/badge) + +[![Latest Stable Version](https://poser.pugx.org/sunnysideup/dropdown2autocomplete/version)](https://packagist.org/packages/sunnysideup/dropdown2autocomplete) +[![License](https://poser.pugx.org/sunnysideup/dropdown2autocomplete/license)](https://packagist.org/packages/sunnysideup/dropdown2autocomplete) +[![Monthly Downloads](https://poser.pugx.org/sunnysideup/dropdown2autocomplete/d/monthly)](https://packagist.org/packages/sunnysideup/dropdown2autocomplete) + + +## Documentation + + + + * [Developer Docs](docs/en/INDEX.md) + * [User Guide](docs/en/userguide.md) + * [API](http://ssmods.com/apis/dropdown2autocomplete/docs/en/api/) + +## Requirements + + + +see [composer.json](composer.json) for details + +### Suggested Modules + + + +see [composer.json](composer.json) for details + + +## Installation + + +``` +composer require sunnysideup/dropdown2autocomplete +``` + +### Configuration + + + +In the `_config` folder you will find the `dropdown2autocomplete.yml.example` +file that shows options for the configuration of this module. + +We recommend that you: + + 1. copy these `dropdown2autocomplete.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.