Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.6 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.6 KB

{{pluginName}}

Build Status Total Downloads License

{{@TODO description}}

Install

Using Composer:

composer require gourmet/{{lcPluginName}}:dev-master

You then need to load the plugin. In boostrap.php, something like:

\Cake\Core\Plugin::load('Gourmet/{{ccPluginName}}');

Usage

{{@TODO documentation}}

Patches & Features

  • Fork
  • Mod, fix
  • Test - this is important, so it's not unintentionally broken
  • Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
  • Pull request - bonus point for topic branches

To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards. A pre-commit hook has been included to automatically run the code sniffs for you:

ln -s ../../contrib/pre-commit .git/hooks/.

Bugs & Feedback

https://github.com/gourmet/{{lcPluginName}}/issues

License

Copyright (c) 2015, Jad Bitar and licensed under The MIT License.