Skip to content

Commit 0e2d3e3

Browse files
committed
modified document
1 parent 7d234dd commit 0e2d3e3

2 files changed

Lines changed: 53 additions & 5 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Ensure require is present in composer.json. This will install the plugin into Pl
2020

2121
{
2222
"require": {
23-
"slywalker/boost_cake": "dev-master"
23+
"slywalker/boost_cake": "*"
2424
}
2525
}
26-
26+
2727
## Documentation
2828

2929
[BoostCake - Bootstrap Plugin for CakePHP](http://slywalker.github.io/cakephp-plugin-boost_cake/)

View/BoostCake/index.ctp

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,50 @@
22
<?php $this->set('title_for_layout', 'Bootstrap Plugin for CakePHP'); ?>
33

44
<div class="hero-unit">
5-
<h1>BoostCake</h1>
5+
<h1>
6+
BoostCake
7+
<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>
8+
</h1>
69
<p>
710
This is a plugin for CakePHP using Bootstrap
811
</p>
12+
<p>
13+
<a href="https://travis-ci.org/slywalker/cakephp-plugin-boost_cake">
14+
<img src="https://travis-ci.org/slywalker/cakephp-plugin-boost_cake.png" alt="Build Status">
15+
</a>
16+
<a href="https://packagist.org/packages/slywalker/boost_cake">
17+
<img src="https://poser.pugx.org/slywalker/boost_cake/d/total.png" alt="Total Downloads">
18+
</a>
19+
<a href="https://packagist.org/packages/slywalker/boost_cake">
20+
<img src="https://poser.pugx.org/slywalker/boost_cake/v/stable.png" alt="Latest Stable Version">
21+
</a>
22+
</p>
923
<p>
1024
<a href="https://github.com/slywalker/cakephp-plugin-boost_cake" class="btn btn-primary btn-large">
11-
Github Project &raquo;
25+
Github Project <i class="icon-chevron-right icon-white"></i>
26+
</a>
27+
<a href="https://packagist.org/packages/slywalker/boost_cake" class="btn btn-primary btn-large">
28+
Packagist <i class="icon-chevron-right icon-white"></i>
1229
</a>
1330
</p>
1431
</div>
1532

1633
<div class="page-header">
17-
<h2>Install</h2>
34+
<h2>Installation</h2>
1835
</div>
1936

37+
<h3>Composer</h3>
38+
<p>
39+
Ensure require is present in <code>composer.json</code>.
40+
This will install the plugin into <code>Plugin/BoostCake</code>:
41+
</p>
42+
43+
<pre class="prettyprint">{
44+
"require": {
45+
"slywalker/boost_cake": "*"
46+
}
47+
}</pre>
48+
2049
<h3>Enable plugin</h3>
2150
<p>You need to enable the plugin your app/Config/bootstrap.php file:</p>
2251
<pre class="prettyprint">CakePlugin::load('BoostCake');</pre>
@@ -34,4 +63,23 @@ class AppController extends Controller {
3463
'Paginator' => array('className' => 'BoostCake.BoostCakePaginator'),
3564
);
3665
66+
}"); ?></pre>
67+
68+
<h3>AuthComponet setting</h3>
69+
<pre class="prettyprint"><?php echo h("<?php
70+
class AppController extends Controller {
71+
72+
public \$components = array(
73+
'Auth' => array(
74+
'flash' => array(
75+
'element' => 'alert',
76+
'key' => 'auth',
77+
'params' => array(
78+
'plugin' => 'BoostCake',
79+
'class' => 'alert-error'
80+
)
81+
)
82+
)
83+
);
84+
3785
}"); ?></pre>

0 commit comments

Comments
 (0)