Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit 443a19c

Browse files
committed
Clean up README a bit
1 parent 5a85af5 commit 443a19c

1 file changed

Lines changed: 25 additions & 21 deletions

File tree

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ into your GitHub-flavored-Markdown user content.
99
The Task List feature is actually made of several different components:
1010

1111
* 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
12+
* Model: summarizes and task list items
13+
* JavaScript: task list update behavior
1514
* CSS: styles Markdown task list items
1615

1716
## Installation
@@ -24,36 +23,41 @@ And then execute:
2423

2524
$ bundle
2625

27-
### Rails 3+: Rails Engine?
26+
### Rails 3+: Railtie method
2827

29-
TBD
30-
31-
### Rails 2.3: Manual.
28+
``` ruby
29+
# config/application.rb
30+
require 'task_list/railtie'
31+
```
3232

33-
TBD
33+
### Rails 2.3: Manual method
3434

35-
### CoffeeScript Requirements
35+
Wherever you have your Sprockets setup:
3636

37-
The following Bower packages are required:
37+
``` ruby
38+
# Load TaskList assets
39+
require 'task_list/railtie'
40+
TaskList.asset_paths.each do |path|
41+
env.append_path path
42+
end
43+
```
3844

39-
* jquery
40-
* https://github.com/github/crema -- `$.pageUpdate`
41-
* rails-behavior -- `data-remote`
45+
If you're not using Sprockets, you're on your own but it's pretty straight
46+
forward. `task_list/railtie` defines `TaskList.asset_paths` which you can use
47+
to manage building your asset bundles.
4248

43-
## Usage
49+
### CoffeeScript Requirements
4450

45-
TBD
51+
Aside from requiring CoffeeScript, jQuery is the only other requirement.
4652

4753
## Testing and Development
4854

49-
To run the functional tests in the browser, install the necessary components
50-
with `script/bootstrap`:
55+
JavaScript unit tests can be run with `script/testsuite`.
5156

52-
```
53-
script/bootstrap
54-
```
57+
Ruby unit tests can be run with `rake test`.
5558

56-
Then run the server:
59+
Functional tests are more for manual testing in the browser. To run, install
60+
the necessary components with `script/bootstrap` then run the server:
5761

5862
```
5963
rackup -p 4011

0 commit comments

Comments
 (0)