README.rdoc in todoly-0.0.1 vs README.rdoc in todoly-0.0.2
- old
+ new
@@ -1,8 +1,35 @@
= todoly
todoly is REST API client library for Todo.ly (http://todo.ly)
+== Usage
+
+Login (create Todoly instance)
+ todoly = Todoly.new :email => "xxx@example.com", :password => "xxxxxx"
+
+Get project list
+ todoly.projects
+
+Get filter list
+ todoly.filters
+
+Get all task list
+ todoly.tasks
+
+Get task list of a project
+ study = todoly.find_project("Study")
+ study.tasks
+
+Create new task
+ # create task on toplevel
+ todoly.new_task("buy milk")
+ # create task on study project
+ todoly.new_task("write Todoly document", study)
+
+Check task as done
+ task.check
+
== Contributing to todoly
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project