diff --git a/README.md b/README.md index 275507e..91cee99 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![Build Status](https://travis-ci.org/sunnysideup/silverstripe-userpage.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-userpage) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-userpage/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-userpage/?branch=master) [![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-userpage/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-userpage?branch=master) -![helpfulrobot](https://helpfulrobot.io/sunnysideup/userpage/badge) [![Latest Stable Version](https://poser.pugx.org/sunnysideup/userpage/version)](https://packagist.org/packages/sunnysideup/userpage) [![License](https://poser.pugx.org/sunnysideup/userpage/license)](https://packagist.org/packages/sunnysideup/userpage) @@ -17,17 +16,19 @@ * [User Guide](docs/en/userguide.md) * [API Docs](http://docs.ssmods.com/sunnysideup/userpage/classes.xhtml) + ## Requirements -see [composer.json](composer.json) for details +See [composer.json](composer.json) for details + ### Suggested Modules -see [composer.json](composer.json) for details +See [composer.json](composer.json) for details ## Installation @@ -47,9 +48,9 @@ file that shows options for the configuration of this module. We recommend that you: 1. copy these `userpage.yml.example` files into your -`mysite/_config` folder - 2. remove the .example extension - 3. delete the lines you not care about, and +`mysite/_config` folder (where available - otherwise search for `private static $` in the module to see what can be configured) + 2. remove the .example extension, + 3. delete the lines you do not care about, and 4. adjust the configurations that you would like to use. @@ -63,10 +64,15 @@ We welcome any contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for more de -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) +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). For exmaple, we can write tests for this module. ## Author Sunny Side Up Ltd. + + +## Care to see more modules? + +To find other modules, please visit [ssmods.com](http://ssmods.com/). diff --git a/docs/en/phpdox/phpdox.xml b/docs/en/phpdox/phpdox.xml deleted file mode 100755 index 10eb8d5..0000000 --- a/docs/en/phpdox/phpdox.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - -