This repository was archived by the owner on Nov 1, 2017. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +41
-0
lines changed
Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change 1+ # Task Lists
2+
3+ This package provides various components necessary for integrating
4+ [ Task Lists] ( https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments )
5+ into your GitHub-flavored-Markdown user content.
6+
7+ ## Components
8+
9+ The Task List feature is actually made of several different components:
10+
11+ * GitHub-flavored-Markdown Filter
12+ * Model: summarizes and updates task list items
13+ * Controller: provides the update interface (optional)
14+ * JavaScript: enables task list behavior, handles AJAX updates, etc
15+ * CSS: styles Markdown task list items
16+
17+ ## Installation
18+
19+ Add this line to your application's Gemfile:
20+
21+ gem 'task-lists'
22+
23+ And then execute:
24+
25+ $ bundle
26+
27+ ### Rails 3+: Rails Engine?
28+
29+ ### Rails 2.3: Manual.
30+
31+ ## Usage
32+
33+ TODO: Write usage instructions here
34+
35+ ## Contributing
36+
37+ 1 . Fork it
38+ 2 . Create your feature branch (` git checkout -b my-new-feature ` )
39+ 3 . Commit your changes (` git commit -am 'Add some feature' ` )
40+ 4 . Push to the branch (` git push origin my-new-feature ` )
41+ 5 . Create new Pull Request
You can’t perform that action at this time.
0 commit comments