Skip to content

Commit f847e27

Browse files
committed
change readme + add API
1 parent 6b47326 commit f847e27

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Progressjs
1+
# ProgressJS
22

33
> ProgressJs is a JavaScript and CSS3 library which help developers to create and manage progress bar for every objects on the page.
44
@@ -9,15 +9,19 @@
99
2) Execute following JavaScript code in the page:
1010

1111
```javascript
12-
//to set progress-bar for whole page
13-
progressJs().start();
14-
//or for specific element
15-
progressJs("#targetElement").start();
12+
//to set progress-bar for whole page
13+
progressJs().start();
14+
//or for specific element
15+
progressJs("#targetElement").start();
1616
```
1717

1818

1919
Use other methods to increase, decrease or set a auto-increase function for your progress-bar. Furthermore, you can change the template using `setOption` method.
2020

21+
## API
22+
23+
Check the API and method usage with example here: https://github.com/usablica/progress.js/wiki/API
24+
2125
## Build
2226

2327
First you should install `nodejs` and `npm`, then first run this command: `npm install` to install all dependencies.

0 commit comments

Comments
 (0)