euromark 13 年 前
コミット
5513dd0149
1 ファイル変更12 行追加3 行削除
  1. 12 3
      README.md

+ 12 - 3
README.md

@@ -1,11 +1,20 @@
-*** cake2.0 plugin ***
+# Tools
+
+## a cake2.x plugin
 
 This plugin contains several useful tools that can be used in many projects.
 Please fork and help to improve (bugfixing, test cases, ...)
 
-
 POSSIBLE DEPENDENCIES
 - http://www.dereuromark.de/2010/06/22/cakephp-bootstrap-goodies/
 
 CODING STANDARDS
-- http://www.dereuromark.de/coding-standards/
+- http://www.dereuromark.de/coding-standards/
+
+## How to include
+Installing the Plugin is pretty much as with every other CakePHP Plugin.
+
+* Put the files in `APP/Plugin/Tools`
+* Make sure you have `CakePlugin::load('Tools')` or `CakePlugin::loadAll()` in your bootstrap
+
+That's it