Skip to content

Commit e5e9280

Browse files
committed
improve README.md and bower.json
1 parent c693a08 commit e5e9280

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,43 @@ Include jquery and sumtabletotal in your page
3535
```html
3636
<script src="bower_components\jquery\dist\jquery.min.js"></script>
3737
<script src="bower_components\jquery-sumtabletotal\dist\jquery.sumtabletotal.min.js"></script>
38+
```
3839

3940
## Using the plugin
4041
```javascript
4142
$("#yourHtmTable").sumtabletotal({
4243
totalIndexArry: [3, 4, 5],//You need to calculated the total of an columns array index
4344
rateObjectArry: [{numerator: 5, denominator: 4, index: 6}]//Object of calculated percentage,'index' represent the place to save percentage.
4445
});
45-
```
46+
```
47+
#### [demo/](https://github.com/zealzhangz/jquery-sumtabletotal/tree/master/demo)
48+
49+
Contains a simple HTML file to demonstrate your plugin.
50+
51+
#### [dist/](https://github.com/zealzhangz/jquery-sumtabletotal/tree/master/dist)
52+
53+
This is where the generated files are stored once Grunt runs.
54+
55+
#### [.jshintrc](https://github.com/zealzhangz/jquery-sumtabletotal/blob/master/.jshintrc)
56+
57+
List of rules used by JSHint to detect errors and potential problems in JavaScript.
58+
59+
#### [Gruntfile.js](https://github.com/zealzhangz/jquery-sumtabletotal/blob/master/Gruntfile.js)
60+
61+
Contains all automated tasks using Grunt.
62+
63+
#### [package.json](https://github.com/zealzhangz/jquery-sumtabletotal/blob/master/package.json)
64+
65+
Specify all dependencies loaded via Node.JS.
66+
67+
## Contributing
68+
69+
Check [CONTRIBUTING.md](https://github.com/zealzhangz/jquery-sumtabletotal/blob/master/CONTRIBUTING.md)
70+
71+
## History
72+
73+
Check [Release](https://github.com/zealzhangz/jquery-sumtabletotal/releases) list.
74+
75+
## License
76+
77+
[MIT License](http://zenorocha.mit-license.org/)

bower.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"name": "jquery-sumtabletotal",
33
"description": "jQuery plugin to sum total and append total row for an HTML table",
44
"main": "dist/jquery.sumtabletotal.js",
5+
"dependencies": {
6+
"jquery": ">=1.4"
7+
},
58
"authors": [
69
"zealzhangz"
710
],

0 commit comments

Comments
 (0)