11# Task Lists
22
3- [ ![ Gem Version] ( http://img.shields.io/gem/v/task_list.svg )] [ gem ]
4- [ ![ Build Status] ( http://img.shields.io/travis/github/task_list.svg )] [ travis ]
5- [ ![ Dependency Status] ( http://img.shields.io/gemnasium/github/task_list.svg )] [ gemnasium ]
6- [ ![ Inline docs] ( http://inch-ci.org/github/github/task_list.svg?branch=master )] [ inchpages ]
3+ [ ![ Build Status] ( http://img.shields.io/travis/deckar01/task_list.svg )] [ travis ]
74
8- [ gem ] : https://rubygems.org/gems/task_list
9- [ travis ] : https://travis-ci.org/github/task_list
10- [ gemnasium ] : https://gemnasium.com/github/task_list
11- [ inchpages ] : http://inch-ci.org/github/github/task_list
5+ [ travis ] : https://travis-ci.org/deckar01/task_list
126
137This package provides various components necessary for integrating
148[ Task Lists] ( https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments )
15- into your GitHub-flavored- Markdown user content.
9+ into your Markdown user content.
1610
1711## Components
1812
1913The Task List feature is made of several different components:
2014
21- * GitHub-flavored- Markdown Ruby Filter
15+ * Markdown Ruby Filter
2216* Summary Ruby Model: summarizes task list items
2317* JavaScript: frontend task list update behavior
2418* CSS: styles Markdown task list items
@@ -33,7 +27,7 @@ Rendering Task List item checkboxes from source Markdown depends on the `TaskLis
3327
3428``` ruby
3529require ' html/pipeline'
36- require ' task_list/filter'
30+ require ' deckar01- task_list/filter'
3731
3832pipeline = HTML ::Pipeline .new [
3933 HTML ::Pipeline ::MarkdownFilter ,
@@ -77,7 +71,7 @@ NOTE: Updates are not persisted to the server automatically. Persistence is the
7771
7872Read through the documented behaviors and samples [ in the source] [ frontend_behaviors ] for more detail, including documented events.
7973
80- [ frontend_behaviors ] : https://github.com/github /task_list/blob/master/app/assets/javascripts/task_list.coffee
74+ [ frontend_behaviors ] : https://github.com/deckar01 /task_list/blob/master/app/assets/javascripts/task_list.coffee
8175
8276## Installation
8377
@@ -87,23 +81,23 @@ Task Lists are packaged as both a RubyGem with both backend and frontend behavio
8781
8882For the backend Ruby components, add this line to your application's Gemfile:
8983
90- gem 'task_list'
84+ gem 'deckar01- task_list'
9185
9286And then execute:
9387
9488 $ bundle
9589
9690### Frontend: Bower
9791
98- For the frontend components, add ` task_list ` to your Bower dependencies config.
92+ For the frontend components, add ` deckar01- task_list` to your Bower dependencies config.
9993
10094This is the preferred method for including the frontend assets in your application. Alternatively, for Rails methods using ` Sprockets ` , see below.
10195
10296### Frontend: Rails 3+ Railtie method
10397
10498``` ruby
10599# config/application.rb
106- require ' task_list/railtie'
100+ require ' deckar01- task_list/railtie'
107101```
108102
109103### Frontend: Rails 2.3 Manual method
@@ -113,15 +107,15 @@ Wherever you have your Sprockets setup:
113107``` ruby
114108Sprockets ::Environment .new (Rails .root) do |env |
115109 # Load TaskList assets
116- require ' task_list/railtie'
110+ require ' deckar01- task_list/railtie'
117111 TaskList .asset_paths.each do |path |
118112 env.append_path path
119113 end
120114end
121115```
122116
123117If you're not using Sprockets, you're on your own but it's pretty straight
124- forward. ` task_list/railtie ` defines ` TaskList.asset_paths ` which you can use
118+ forward. ` deckar01- task_list/railtie` defines ` TaskList.asset_paths ` which you can use
125119to manage building your asset bundles.
126120
127121### Dependencies
@@ -146,7 +140,3 @@ Navigate to http://localhost:4011/test/functional/test_task_lists_behavior.html
146140## Community Integration
147141- [ Waffle.io] ( http://waffle.io )
148142- [ HuBoard] ( https://huboard.com/ )
149-
150- ## Contributing
151-
152- Read the [ Contributing Guidelines] ( CONTRIBUTING.md ) and open a Pull Request!
0 commit comments