README.md

:package_name

Note: Replace :author_name :author_username :author_website :author_email :vendor :package_name :package_description with their correct values in README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md and composer.json files, then delete this line. You can run $ php prefill.php in the command line to make all replacements at once. Delete the file prefill.php as well.

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Structure

The directory structure of this project should be like this:

phwoolcon-package/
    assets/         # Static assets (js/css/image/fonts ... etc)
    config/         # Config files
    locale/         # Translation files
        en/
        zh_CN/
    views/          # Templates
src/
    Controllers/
    Models/
tests/
    resource/       # Test resources
        assets/
        config/
        locale/
        views/
    Unit/           # Unit test cases
    Integration/    # Integration test cases

Install

Install as a phwoolcon package.

If this library has been published to packagist.org or GitHub.com

bin/import-package :vendor/:package_name

If this is a private repository

bin/import-package :git_repo

Usage

Configuration

See phwoolcon-package/config/

Templates

See phwoolcon-package/views/

Assets

See phwoolcon-package/assets/

Locale

See phwoolcon-package/locale/

Routes

See phwoolcon-package/routes.php

Dependency Injection

See phwoolcon-package/di.php

Controllers

See src/Controllers/

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ vendor/bin/phpunit

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

• :author_name
• All Contributors

License

The MIT License (MIT). Please see License File for more information.