Permalink
Browse files

Add README and MIT-LICENSE files

  • Loading branch information...
1 parent 22a289a commit a8fb45b2968b696e29c1f9996284d87a220d9c6d @jsahlen committed Aug 9, 2011
Showing with 85 additions and 0 deletions.
  1. +20 −0 MIT-LICENSE.txt
  2. +65 −0 README.md
View
@@ -0,0 +1,20 @@
+Copyright (c) 2011 Johan Sahlén, http://jsahlen.se/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -0,0 +1,65 @@
+# Todotxt.rb
+
+*todo.txt with a ruby flair*
+
+
+## About
+
+Todotxt is a ruby CLI interface to work with a
+[todo.txt](http://www.todotxt.com) file
+
+
+## Install
+
+Clone from [jsahlen/todotxt](http://github.com/jsahlen/todotxt) and do
+
+ rake install
+
+I might release it as a proper gem in the future…
+
+Todotxt relies on a configuration file (`.todotxt.cfg`) in your home directory,
+which points to the location of your todo.txt. You can run
+
+ todotxt generate_cfg
+
+to generate this file, which will then point to `~/todo.txt`.
+
+
+## Usage
+
+The gem will install a command, `todotxt` which is used to interact with your
+todo.txt.
+
+ Tasks:
+ todotxt add | a TEXT # Add a new Todo item
+ todotxt append | app ITEM# STRING # Append STRING to ITEM#
+ todotxt del | rm ITEM#[, ITEM#, ITEM#, ...] # Remove ITEM#
+ todotxt do ITEM#[, ITEM#, ITEM#, ...] # Mark ITEM# as done
+ todotxt dp | depri ITEM#[, ITEM#, ITEM#, ...] # Remove priority for ITEM#
+ todotxt generate_cfg # Create a sample todo.txt
+ todotxt generate_config # Create a .todotxt.cfg file in your home folder, containing the path to todo.txt
+ todotxt help [TASK] # Describe available tasks or one specific task
+ todotxt list | ls [SEARCH] # List all todos, or todos matching SEARCH
+ todotxt listproj | lsproj # List all projects
+ todotxt lscon | lsc # List all contexts
+ todotxt lsdone | lsd # List all done items
+ todotxt prepend | prep ITEM# STRING # Prepend STRING to ITEM#
+ todotxt pri | p ITEM# PRIORITY # Set priority of ITEM# to PRIORITY
+ todotxt replace ITEM# TEXT # Completely replace ITEM# text with TEXT
+ todotxt undo | u ITEM#[, ITEM#, ITEM#, ...] # Mark ITEM# item as not done
+ todotxt version # Show todotxt version
+
+Calling simply `todotxt` will automatically run the `ls` command.
+
+
+## Dependencies
+
+* [Thor](http://github.com/wycats/thor)
+* [Rainbow](http://github.com/sickill/rainbow)
+* [ParseConfig](http://www.5dollarwhitebox.org/drupal/?q=node/21)
+
+
+## Bugs
+
+Please report any bugs using the
+[GitHub Issue Tracker](http://github.com/jsahlen/todotxt/issues).

0 comments on commit a8fb45b

Please sign in to comment.