Skip to content

Commit 313a48d

Browse files
committed
Grammar, capitalization
1 parent e5e9654 commit 313a48d

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@
2525

2626
pjax is a jQuery plugin that uses ajax and pushState to deliver a fast browsing experience with real permalinks, page titles, and a working back button.
2727

28-
pjax works by grabbing html from your server via ajax and replacing the content of a container on your page with the ajax'd html. It then updates the browser's current url using pushState without reloading your page's layout or any resources (js, css), giving the appearance of a fast, full page load. But really it's just ajax and pushState.
28+
pjax works by grabbing html from your server via ajax and replacing the content
29+
of a container on your page with the ajax'd html. It then updates the browser's
30+
current URL using pushState without reloading your page's layout or any
31+
resources (JS, CSS), giving the appearance of a fast, full page load. But really
32+
it's just ajax and pushState.
2933

3034
For [browsers that don't support pushState][compat] pjax fully degrades.
3135

@@ -50,7 +54,9 @@ Consider the following page.
5054
</html>
5155
```
5256

53-
We want pjax to grab the url `/page/2` then replace `#pjax-container` with whatever it gets back. No styles or scripts will be reloaded and even the h1 can stay the same - we just want to change the `#pjax-container` element.
57+
We want pjax to grab the URL `/page/2` then replace `#pjax-container` with
58+
whatever it gets back. No styles or scripts will be reloaded and even the `<h1>`
59+
can stay the same - we just want to change the `#pjax-container` element.
5460

5561
We do this by telling pjax to listen on `a` tags and use `#pjax-container` as the target container:
5662

@@ -88,7 +94,7 @@ Via [Bower][]:
8894
$ bower install jquery-pjax
8995
```
9096

91-
Or add `jquery-pjax` to your apps `bower.json`.
97+
Or, add `jquery-pjax` to your app's `bower.json`.
9298

9399
``` json
94100
"dependencies": {
@@ -112,7 +118,10 @@ Requires jQuery 1.8.x or higher.
112118

113119
## Compatibility
114120

115-
pjax only works with [browsers that support the `history.pushState` API][compat]. When the API isn't supported pjax goes into fallback mode: `$.fn.pjax` calls will be a no-op and `$.pjax` will hard load the given url. This mode targets the browser requirements of the jQuery version being used.
121+
pjax only works with [browsers that support the `history.pushState`
122+
API][compat]. When the API isn't supported pjax goes into fallback mode:
123+
`$.fn.pjax` calls will be a no-op and `$.pjax` will hard load the given URL.
124+
This mode targets the browser requirements of the jQuery version being used.
116125

117126
For debugging purposes, you can intentionally disable pjax even if the browser supports `pushState`. Just call `$.pjax.disable()`. To see if pjax is actually supports `pushState`, check `$.support.pjax`.
118127

0 commit comments

Comments
 (0)