Skip to content

Commit

Permalink
modified document
Browse files Browse the repository at this point in the history
  • Loading branch information
slywalker committed Jun 27, 2013
1 parent 7d234dd commit 0e2d3e3
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Ensure require is present in composer.json. This will install the plugin into Pl

{
"require": {
"slywalker/boost_cake": "dev-master"
"slywalker/boost_cake": "*"
}
}

## Documentation

[BoostCake - Bootstrap Plugin for CakePHP](http://slywalker.github.io/cakephp-plugin-boost_cake/)
Expand Down
54 changes: 51 additions & 3 deletions View/BoostCake/index.ctp
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,50 @@
<?php $this->set('title_for_layout', 'Bootstrap Plugin for CakePHP'); ?>

<div class="hero-unit">
<h1>BoostCake</h1>
<h1>
BoostCake
<iframe src="http://ghbtns.com/github-btn.html?user=slywalker&repo=cakephp-plugin-boost_cake&type=watch&count=true&size=large" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe>
</h1>
<p>
This is a plugin for CakePHP using Bootstrap
</p>
<p>
<a href="https://travis-ci.org/slywalker/cakephp-plugin-boost_cake">
<img src="https://travis-ci.org/slywalker/cakephp-plugin-boost_cake.png" alt="Build Status">
</a>
<a href="https://packagist.org/packages/slywalker/boost_cake">
<img src="https://poser.pugx.org/slywalker/boost_cake/d/total.png" alt="Total Downloads">
</a>
<a href="https://packagist.org/packages/slywalker/boost_cake">
<img src="https://poser.pugx.org/slywalker/boost_cake/v/stable.png" alt="Latest Stable Version">
</a>
</p>
<p>
<a href="https://github.com/slywalker/cakephp-plugin-boost_cake" class="btn btn-primary btn-large">
Github Project &raquo;
Github Project <i class="icon-chevron-right icon-white"></i>
</a>
<a href="https://packagist.org/packages/slywalker/boost_cake" class="btn btn-primary btn-large">
Packagist <i class="icon-chevron-right icon-white"></i>
</a>
</p>
</div>

<div class="page-header">
<h2>Install</h2>
<h2>Installation</h2>
</div>

<h3>Composer</h3>
<p>
Ensure require is present in <code>composer.json</code>.
This will install the plugin into <code>Plugin/BoostCake</code>:
</p>

<pre class="prettyprint">{
"require": {
"slywalker/boost_cake": "*"
}
}</pre>

<h3>Enable plugin</h3>
<p>You need to enable the plugin your app/Config/bootstrap.php file:</p>
<pre class="prettyprint">CakePlugin::load('BoostCake');</pre>
Expand All @@ -34,4 +63,23 @@ class AppController extends Controller {
'Paginator' => array('className' => 'BoostCake.BoostCakePaginator'),
);
}"); ?></pre>

<h3>AuthComponet setting</h3>
<pre class="prettyprint"><?php echo h("<?php
class AppController extends Controller {
public \$components = array(
'Auth' => array(
'flash' => array(
'element' => 'alert',
'key' => 'auth',
'params' => array(
'plugin' => 'BoostCake',
'class' => 'alert-error'
)
)
)
);
}"); ?></pre>

0 comments on commit 0e2d3e3

Please sign in to comment.