Skip to content

Commit 38f6434

Browse files
committed
Update README.
1 parent 3820293 commit 38f6434

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

README.markdown

+24-14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
jQuery Table Sorter plugin for Rails
2-
===
1+
# jQuery Table Sorter plugin for Rails
32

43
Simple integration of jquery-tablesorter into the asset pipeline.
54

@@ -8,26 +7,29 @@ Current tablesorter version: 2.4.6 (10/25/2012), [documentation]
87
Any issue associate with the js/css files, please report to [Mottie's fork].
98

109

11-
NOTICE:
12-
---
10+
## NOTICE:
1311

1412
v0.0.5 users, from v1.0.0, this gem will use [Mottie's fork] :smile:.
1513

16-
Install
17-
---
18-
In your Gemfile
14+
## Installation
1915

20-
```ruby
21-
gem 'jquery-tablesorter'
22-
```
16+
Add this line to your application's Gemfile:
17+
18+
gem 'jquery-tablesorter'
19+
20+
And then execute:
21+
22+
$ bundle
2323

24-
Requirements
25-
---
24+
Or install it yourself as:
25+
26+
$ gem install jquery-tablesorter
27+
28+
## Requirements
2629

2730
Rails 3.1 and higher
2831

29-
Usage
30-
---
32+
## Usage
3133

3234
### JavaScript files
3335

@@ -79,6 +81,14 @@ pager theme:
7981
*/
8082
```
8183

84+
## Contributing
85+
86+
1. Fork it
87+
2. Create your feature branch (`git checkout -b my-new-feature`)
88+
3. Commit your changes (`git commit -am 'Added some feature'`)
89+
4. Push to the branch (`git push origin my-new-feature`)
90+
5. Create new Pull Request
91+
8292
[Mottie's fork]: https://github.com/Mottie/tablesorter
8393
[documentation]: http://mottie.github.com/tablesorter/docs/index.html
8494

0 commit comments

Comments
 (0)