Skip to content

Commit

Permalink
Fix grammar and formatting in README
Browse files Browse the repository at this point in the history
  • Loading branch information
bcrowe committed Oct 2, 2015
1 parent 06a2b54 commit a16e027
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ Plugin::load('BryanCrowe/ApiPagination');

## Usage

Make sure your application has been set up to use data views; see the [Enabling Data Views in Your Application](http://book.cakephp.org/3.0/en/views/json-and-xml-views.html#enabling-data-views-in-your-application) section of the CakePHP documentation.
Make sure your application has been set up to use data views; see the
[Enabling Data Views in Your Application][link-dataviews] section of the CakePHP
documentation.

Then, load `ApiPaginationComponent`:

Expand Down Expand Up @@ -78,8 +80,8 @@ ApiPagination has three keys for configuration: `key`, `aliases`, and `visible`.
* `aliases` allows you to change names of the pagination detail keys.

* `visible` allows you to set which pagination keys will be exposed in the
response. **Note:** Whenever setting keys' visibility, make sure to use the aliased name
if you've given it one.
response. **Note:** Whenever setting a key's visibility, make sure to use the
aliased name if you've given it one.

An example using all these configuration keys:

Expand Down Expand Up @@ -115,7 +117,8 @@ This configuration would yield:

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed
recently.

## Testing

Expand All @@ -129,7 +132,8 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.
If you discover any security related issues, please email [email protected]
instead of using the issue tracker.

## Credits

Expand All @@ -138,7 +142,8 @@ If you discover any security related issues, please email [email protected]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
The MIT License (MIT). Please see [License File](LICENSE.md) for more
information.

[ico-version]: https://img.shields.io/packagist/v/bcrowe/cakephp-api-pagination.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
Expand All @@ -154,3 +159,4 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
[link-downloads]: https://packagist.org/packages/bcrowe/cakephp-api-pagination
[link-author]: https://github.com/bcrowe
[link-contributors]: ../../contributors
[link-dataviews]: http://book.cakephp.org/3.0/en/views/json-and-xml-views.html#enabling-data-views-in-your-application

0 comments on commit a16e027

Please sign in to comment.