Skip to content

Commit a16e027

Browse files
committed
Fix grammar and formatting in README
1 parent 06a2b54 commit a16e027

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ Plugin::load('BryanCrowe/ApiPagination');
2626

2727
## Usage
2828

29-
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.
29+
Make sure your application has been set up to use data views; see the
30+
[Enabling Data Views in Your Application][link-dataviews] section of the CakePHP
31+
documentation.
3032

3133
Then, load `ApiPaginationComponent`:
3234

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

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

8486
An example using all these configuration keys:
8587

@@ -115,7 +117,8 @@ This configuration would yield:
115117

116118
## Changelog
117119

118-
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
120+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed
121+
recently.
119122

120123
## Testing
121124

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

130133
## Security
131134

132-
If you discover any security related issues, please email bryan@bryan-crowe.com instead of using the issue tracker.
135+
If you discover any security related issues, please email bryan@bryan-crowe.com
136+
instead of using the issue tracker.
133137

134138
## Credits
135139

@@ -138,7 +142,8 @@ If you discover any security related issues, please email bryan@bryan-crowe.com
138142

139143
## License
140144

141-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
145+
The MIT License (MIT). Please see [License File](LICENSE.md) for more
146+
information.
142147

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

0 commit comments

Comments
 (0)