Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge branch 'release/v0.4.1'

  • Loading branch information...
commit c36c4c555d178f5a2adb2a02a4753c69b17c639e 2 parents 97bde4c + ec4a930
@rogeriopvl authored
Showing with 90 additions and 1 deletion.
  1. +88 −0 doc/nodo.1
  2. +2 −1  package.json
View
88 doc/nodo.1
@@ -0,0 +1,88 @@
+.TH "NODO" "" "September 2013" "" ""
+.SH "NAME"
+\fBNodo\fR
+.SH About
+.P
+Nodo is a command line TODO application that uses a portable database file\. Also, if you are a Wunderlist \fIhttp://wunderlist\.com\fR user, you can configure Nodo to be a command line interface to Wunderlist\'s database (only for version 1\.* of Wunderlist)\.
+.P
+The name "Nodo" comes from the mix of the words Node and TODO\.
+.SH Install
+.P
+Nodo is available as a package in the npm registry, so you can install it with:
+.P
+.RS 2
+.EX
+npm install \-g nodo
+.EE
+.RE
+.P
+At install, Nodo creates a default configuration file (\fB~/\.nodorc\fR) and a default local database (\fB~/\.nodo\.db\fR) with some sample tasks just to get you started\.
+You can rename and/or move you database file as long as you update your config file to reflect it\'s current location\.
+.SS Using Wunderlist database (only for Wunderlist 1\.*)
+.P
+\fIImportant:\fR Nodo is not compatible with Wunderlist 2\. And I don\'t plan to fix this in the near future unless there\'s high demand\.
+.P
+I you wan\'t to use the Wunderlist database with Nodo you need to edit the config file and make sure that the database location parameter has the Wunderlist database file path\. For instance in Mac OSX, the Wunderlist database file is at \fB~/Library/Wunderlist/wunderlist\.db\fR, so just make your config file look like this:
+.P
+.RS 2
+.EX
+{
+ "database": {
+ "location": "~/Library/Wunderlist/wunderlist\.db",
+ }
+}
+.EE
+.RE
+.P
+And you\'ll be all set to organize your day like a hacker!
+.P
+\fIImportant:\fR Nodo does not delete any data in the Wunderlist database\. Even if you delete tasks, they are just marked as deleted, and can be recovered with the \fBnodo restore\fR command\.
+.SH First Run
+.P
+On the first run nodo asks your permission to anonymously track some usage patterns\. This is very useful to improve nodo, but completely optional and anonymous\. Only major commands like \fBshow\fR, \fBhelp\fR, \fBlist\fR, etc are tracked\. Their respective arguments are not tracked\.
+.SH Usage
+.P
+.RS 2
+.EX
+Usage: nodo <action> [arguments]
+
+ Available actions and options:
+ nodo show Show all lists and tasks todo
+ nodo show all Same as above
+ nodo show lists Show all lists and number of tasks in each one\.
+ nodo show <list_name> Show content of list
+ nodo show done Show all done tasks
+ nodo show deleted Show all deleted tasks
+ nodo show task <task_id> Show detail of a task
+
+ nodo add list <list_name> Add a new list
+ nodo add <list_name> <task_name> Add a new task to list
+
+ nodo done <task_id> Mark a task as done
+ nodo undo <task_id> Mark a task as not done
+
+ nodo star <task_id> Mark a task as important
+ nodo unstar <task_id> Mark a task as not important
+
+ nodo move <task_id> <list_name> Moves a task to a list
+
+ nodo delete list <list_name> Delete list
+ nodo delete task <task_id> Delete task
+
+ nodo restore <task_id> Restore task
+ nodo restore task <task_id> Restore task
+ nodo restore list <list_name> Restore list
+.EE
+.RE
+.SH Bug Report
+.P
+Nodo is in it\'s early versions\. If you find any problems using Nodo, please report them back to me by opening an issue on Github\.
+.SH Credits
+.P
+Thanks to:
+.RS 2
+.IP \(bu 2
+Pedro Faria, for his precious help in debugging Nodo on Linux\.
+
+.RE
+
View
3  package.json
@@ -14,7 +14,7 @@
"web": "http://rogeriopvl.com"
}
],
- "version": "0.4.0",
+ "version": "0.4.1",
"repository": {
"type": "git",
"url": "https://github.com/rogeriopvl/nodo"
@@ -41,6 +41,7 @@
"nodo": "./bin/nodo",
"nodo-install": "./bin/nodo-install"
},
+ "man" :[ "./doc/nodo.1" ],
"scripts": {
"install": "./bin/nodo-install",
"test": "grunt test"
Please sign in to comment.
Something went wrong with that request. Please try again.