Skip to content

Commit 1bcb129

Browse files
committed
Adding doc
1 parent fd0b57a commit 1bcb129

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Readme.md

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

4-
[![Status](https://api.travis-ci.org/rstacruz/nprogress.svg?branch=master)](http://travis-ci.org/rstacruz/nprogress)
4+
[![Status](https://api.travis-ci.org/rstacruz/nprogress.svg?branch=master)](http://travis-ci.org/rstacruz/nprogress)
55
[![npm version](https://img.shields.io/npm/v/nprogress.png)](https://npmjs.org/package/nprogress "View this project on npm")
66
[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/nprogress/badge?style=rounded)](https://www.jsdelivr.com/package/npm/nprogress)
77

@@ -44,7 +44,7 @@ NProgress.done();
4444
~~~
4545

4646
### Turbolinks (version 5+)
47-
Ensure you're using Turbolinks 5+, and use
47+
Ensure you're using Turbolinks 5+, and use
4848
this: (explained [here](https://github.com/rstacruz/nprogress/issues/8#issuecomment-239107109))
4949

5050
~~~ js
@@ -58,7 +58,7 @@ $(document).on('turbolinks:render', function() {
5858
~~~
5959

6060
### Turbolinks (version 3 and below)
61-
Ensure you're using Turbolinks 1.3.0+, and use
61+
Ensure you're using Turbolinks 1.3.0+, and use
6262
this: (explained [here](https://github.com/rstacruz/nprogress/issues/8#issuecomment-23010560))
6363

6464
~~~ js
@@ -120,6 +120,9 @@ NProgress.done(true);
120120

121121
__Get the status value:__ To get the status value, use `.status`
122122

123+
__Pause progress:__ To temporary halt trickling of progress, call `.pause` and resume with `.continue`.
124+
This is a non persistent operation, which means next `.start` will make progress continuously if trickle is true
125+
123126
Configuration
124127
-------------
125128

0 commit comments

Comments
 (0)