Skip to content

Commit d8439dd

Browse files
zackbloomzackbloom
committed
Merge pull request CodeByZach#45 from AnSavvides/master
Adding a more elaborate and informative README
2 parents d1e4e2a + 081c290 commit d8439dd

2 files changed

Lines changed: 24 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
11
pace
22
====
33

4-
Automatic web page progress bar.
4+
An automatic web page progress bar.
55

6-
### [Demo](http://github.hubspot.com/pace/docs/welcome/)
7-
### [Documentation](http://github.hubspot.com/pace/)
6+
Include pace.js and a CSS theme of your choice to your page and you are done!
7+
8+
Pace will automatically monitor your Ajax requests, event loop lag, document ready state and elements on your page to decide on the progress.
9+
10+
If you use AMD or Browserify, require pace.js and call `pace.start()` as early in the loading process as is possible.
11+
12+
### Demo
13+
14+
You can see a [live demo here](http://github.hubspot.com/pace/docs/welcome/)
15+
16+
### Documentation
17+
18+
You can find [all relevant documentation here](http://github.hubspot.com/pace/)
19+
20+
### Example
21+
22+
```html
23+
<head>
24+
<script src="/pace/pace.js"></script>
25+
<link href="/pace/themes/pace-theme-barber-shop.css" rel="stylesheet" />
26+
</head>
27+
```

‎docs/welcome/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ <h3>Automatic page load progress bar</h3>
412412
<div class="section">
413413
<div class="page">
414414
<h2>What is Pace?</h2>
415-
<p style="text-align: left">Include pace.js and the theme css of your choice, and you get a beautiful progress indicator for your page load and ajax navigation.</p>
415+
<p style="text-align: left">Include pace.js and a CSS theme of your choice, and you get a beautiful progress indicator for your page load and ajax navigation.</p>
416416
<p style="text-align: left">No need to hook into any of your code, progress is detected automatically.</p>
417417
<br/>
418418
<h2>Download</h2>

0 commit comments

Comments
 (0)