Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Example Readme for CakePHP plugins that use MIT license

[PLUGIN NAME] Plugin

[ONE LINE DESCRIPTION OF PROJECT]

Background

[A PARAGRAPH DESCRIBING WHY YOU BUILT THIS]

[ANOTHER PARAGRAPH DESCRIBING YOUR IMPETUS FOR RELEASING THIS]

Requirements

  • [PHP_VERSION REQUIREMENT]
  • [CAKEPHP_VERSION REQUIREMENT]
  • [REQUIRED PLUGINS]
  • [OTHER EXTERNAL DEPENDENCIES]
  • [SNARKY COMMENT HERE]

Installation

[Using Composer]

Add the plugin to your project's composer.json - something like this:

{
    "require": {
        "[GITHUB_USERNAME]/[REPOSITORY_NAME]": "[VERSION]"
    }
}

Because this plugin has the type cakephp-plugin set in it's own composer.json, composer knows to install it inside your /Plugins directory, rather than in the usual vendors file. It is recommended that you add /Plugins/[PLUGIN_NAME] to your .gitignore file. (Why? read this.)

[Manual]

[GIT Submodule]

In your app directory type:

git submodule add git://github.com/[GITHUB_USERNAME]/[REPOSITORY_NAME].git plugins/[PLUGIN_NAME]
git submodule init
git submodule update

[GIT Clone]

In your plugin directory type

git clone git://github.com/[GITHUB_USERNAME]/[REPOSITORY_NAME].git [PLUGIN_NAME]

Usage

[EXAMPLE ON HOW TO SETUP YOUR PLUGIN]

[PARAGRAPH EXPLAINING DIFFERENT WAYS TO CONFIGURE THE PLUGIN]

Options

  • [ONE OPTION] : [OPTION EXPLANATION]
  • [ANOTHER OPTION] : [OPTION EXPLANATION]
  • [YET ANOTHER OPTION]
  • [VALID PARAMETER]
  • [ANOTHER VALID PARAMETER]

Todo

  • [TODO ITEM]
  • [ANOTHER ITEM]
  • -[COMPLETED ITEM]-

License

Copyright (c) [CURRENT_YEAR] [YOUR_NAME]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

@jmcneese

This comment has been minimized.

Copy link

@jmcneese jmcneese commented Apr 5, 2011

nice. i'll use this for Bitmasked.

@zoghal

This comment has been minimized.

Copy link

@zoghal zoghal commented Feb 11, 2013

thanks

@josegonzalez

This comment has been minimized.

Copy link
Owner Author

@josegonzalez josegonzalez commented Jun 26, 2014

Updated for markdown!

@cake17

This comment has been minimized.

Copy link

@cake17 cake17 commented Aug 6, 2015

nice readme, thanks ! Just the part with composer installation and plugins/ folder may need to be changed as composer will now install plugins in vendor/ folder.

Perhaps something like :

Composer will install the plugin in `vendor/[GITHUB_USERNAME]/[PLUGIN_NAME]` in production.
Clone your plugin in `/plugins` folder only when you're developing it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment