Skip to content

Commit adcc9f9

Browse files
committed
Update README to add all installation steps
1 parent aff356f commit adcc9f9

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,52 @@ A lightweight Rails engine that lets any model manage task lists and tasks with
33

44
![Totoro](totoro.png)
55

6-
## Usage
6+
## Installation
77

8-
Include Taskable in the model(s) that can have tasks
8+
Add to your Gemfile:
99

1010
```ruby
11-
class Project < ApplicationRecord
12-
acts_as_taskable
13-
end
11+
gem "todoro"
1412
```
1513

16-
Now, a Project can have task lists and tasks!
14+
And then execute:
1715

1816
```bash
19-
project = Project.create(name: "Website Redesign")
20-
task_list = project.create_task_list("Development Tasks")
21-
task = project.add_task_to_list(task_list, "Build homepage", "Implement UI components")
17+
$ bundle
18+
```
2219

23-
puts project.tasks # Lists all tasks in all its task lists
20+
Or install it yourself as:
21+
22+
```bash
23+
$ gem install todoro
2424
```
2525

26-
## Installation
26+
## Usage
2727

28-
Add to your Gemfile:
28+
Generate the required migrations
2929

3030
```ruby
31-
gem "todoro"
31+
rails todoro:install:migrations
3232
```
3333

34-
And then execute:
34+
Include Taskable in the model(s) that can have tasks
3535

36-
```bash
37-
$ bundle
36+
```ruby
37+
class Project < ApplicationRecord
38+
acts_as_taskable
39+
end
3840
```
3941

40-
Or install it yourself as:
42+
Now, a Project can have task lists and tasks!
4143

4244
```bash
43-
$ gem install todoro
45+
project = Project.create(name: "Website Redesign")
46+
task_list = project.create_task_list("Development Tasks")
47+
task = project.add_task_to_list(task_list, "Build homepage", "Implement UI components")
48+
49+
puts project.tasks # Lists all tasks in all its task lists
4450
```
4551

52+
4653
## License
4754
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)