Skip to content

Commit 74a066b

Browse files
committed
Add some basic instructions to README
1 parent 591732e commit 74a066b

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cakephp-api-pagination
1+
# CakePhp API Pagination
22

33
[![Latest Version on Packagist][ico-version]][link-packagist]
44
[![Software License][ico-license]](LICENSE.md)
@@ -7,8 +7,8 @@
77
[![Quality Score][ico-code-quality]][link-code-quality]
88
[![Total Downloads][ico-downloads]][link-downloads]
99

10-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
11-
PSRs you support to avoid any confusion with users and contributors.
10+
This is a simple component for CakePHP 3 which injects pagination information
11+
from CakePHP's Paginator, into Json and Xml View responses.
1212

1313
## Install
1414

@@ -18,11 +18,23 @@ Via Composer
1818
$ composer require bcrowe/cakephp-api-pagination
1919
```
2020

21+
Then make sure to load the plugin in your application's `bootstrap.php` file.
22+
23+
``` php
24+
Plugin::load('BryanCrowe/ApiPagination');
25+
```
26+
2127
## Usage
2228

29+
Load the component in a controller's `initialize()` method:
30+
31+
2332
``` php
24-
$skeleton = new BryanCrowe\Skeleton();
25-
echo $skeleton->echoPhrase('Hello, Bryan!');
33+
public function initialize()
34+
{
35+
parent::initialize();
36+
$this->loadComponent('BryanCrowe/ApiPagination');
37+
}
2638
```
2739

2840
## Change log

0 commit comments

Comments
 (0)