|
1 |
| -ProgressJS |
2 |
| -========== |
| 1 | +# Progressjs |
3 | 2 |
|
4 |
| -ProgressJs is a JavaScript and CSS3 library which help developers to create and manage progress bar for every objects on the page. |
| 3 | +> ProgressJs is a JavaScript and CSS3 library which help developers to create and manage progress bar for every objects on the page. |
5 | 4 |
|
| 5 | +## How To Use |
6 | 6 |
|
| 7 | +1) Include `progress.js` and `progressjs.css` in the page (use minified version from `minified` folder for production) |
| 8 | + |
| 9 | +2) Execute following JavaScript code in the page: |
| 10 | + |
| 11 | +```javascript |
| 12 | + //to set progress-bar for whole page |
| 13 | + progressJs().start(); |
| 14 | + //or for specific element |
| 15 | + progressJs("#targetElement").start(); |
| 16 | +``` |
| 17 | + |
| 18 | + |
| 19 | +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. |
| 20 | + |
| 21 | +## Build |
| 22 | + |
| 23 | +First you should install `nodejs` and `npm`, then first run this command: `npm install` to install all dependencies. |
| 24 | + |
| 25 | +Now you can run this command to minify all static resources: |
| 26 | + |
| 27 | + make build |
| 28 | + |
| 29 | +## Roadmap |
| 30 | +- More browser compatibility + mobile/tablet device support |
| 31 | +- Add more templates |
| 32 | + |
| 33 | +## Release History |
| 34 | + * **v0.1.0** - 2014-02-14 |
| 35 | + - First version |
| 36 | + - Increase, decrease and auto-increase functions |
| 37 | + - Ability to design and add templates |
| 38 | + |
| 39 | +## Author |
| 40 | +**Afshin Mehrabani** |
| 41 | + |
| 42 | +- [Twitter](https://twitter.com/afshinmeh) |
| 43 | +- [Github](https://github.com/afshinm) |
| 44 | +- [Personal page](http://afshinm.name/) |
| 45 | + |
| 46 | +## License |
| 47 | +> Copyright (C) 2012 Afshin Mehrabani ([email protected]) |
| 48 | +
|
| 49 | +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated |
| 50 | +documentation files (the "Software"), to deal in the Software without restriction, including without limitation |
| 51 | +the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, |
| 52 | +and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
| 53 | +The above copyright notice and this permission notice shall be included in all copies or substantial portions |
| 54 | +of the Software. |
| 55 | + |
| 56 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED |
| 57 | +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 58 | +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF |
| 59 | +CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
| 60 | +IN THE SOFTWARE. |
0 commit comments