Skip to content

Commit 0768575

Browse files
committed
Add links to readme
1 parent 7b147fc commit 0768575

2 files changed

Lines changed: 18 additions & 13 deletions

File tree

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
<script src="https://rawgithub.com/HubSpot/pace/v0.4.0/pace.min.js"></script>
2+
<link type="text/css" href="https://rawgithub.com/HubSpot/pace/v0.4.0/themes/pace-theme-barber-shop.css"></link>
3+
14
pace
25
====
36

47
Automatic page load progress bar
58

6-
Include pace.js and the theme css of your choice on your page (as early as is possible), and you're done!
9+
Include [pace.js](https://raw.github.com/HubSpot/pace/v0.4.0/pace.min.js) and the
10+
[theme](http://github.hubspot.com/pace/docs/themes/) css of your choice on your page
11+
(as early as is possible), and you're done!
712

813
If you use AMD or Browserify, require in pace.js and call `pace.start()` as early in
914
the loading process as is possible.
@@ -42,8 +47,9 @@ define(['pace'], function(pace){
4247
Themes
4348
------
4449

45-
Pace includes a bunch of themes to get you started. Specify the theme of your choice as
46-
an option, and include the appropriate css file.
50+
Pace includes a bunch of [themes](http://github.hubspot.com/pace/docs/themes/)
51+
to get you started. Specify the theme of your choice as an option, and
52+
include the appropriate css file.
4753

4854
Collectors
4955
----------
@@ -105,18 +111,12 @@ API
105111

106112
Pace exposes the following methods:
107113

108-
- `Pace.start`
109-
110-
Show the progress bar and start updating. Called automatically if you don't use AMD or CommonJS.
111-
112-
- `Pace.restart`
114+
- `Pace.start`: Show the progress bar and start updating. Called automatically if you don't use AMD or CommonJS.
113115

114-
Show the progress bar if it's hidden and start reporting the progress from scratch. Called automatically
116+
- `Pace.restart`: Show the progress bar if it's hidden and start reporting the progress from scratch. Called automatically
115117
whenever `pushState` or `replaceState` is called by default.
116118

117-
- `Pace.stop`
118-
119-
Hide the progress bar and stop updating it.
119+
- `Pace.stop`: Hide the progress bar and stop updating it.
120120

121121
Dependencies
122122
------------
@@ -130,6 +130,11 @@ Pace is designed to support IE8+ (standards mode), FF 3.5+, Chrome, Safari 4+, O
130130
mobile browsers. If you run into a compatibility issue, or can make a case for supporting something else,
131131
please create an issue.
132132

133+
Size
134+
----
135+
136+
pace.js is 4kb minified and gzipped. The themes vary between 0.5 and 4kb.
137+
133138
Issues
134139
------
135140

docs/themes/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<div class="page">
9898
<h1>Pace</h1>
9999
<h2>Themes</h2>
100-
<p>Couple one of these themes with <a href=#>pace.js</a> and you're ready to go!</p>
100+
<p>Couple one of these themes with <a href="https://raw.github.com/HubSpot/pace/v0.4.0/pace.min.js">pace.js</a> and you're ready to go!</p>
101101
<input type="color" value="#2299dd"></input>
102102
<div class="themes"></div>
103103
<script>

0 commit comments

Comments
 (0)