Go to file
jamesclonk@jamesclonk.ch 434ae30216 added travis-ci build status 2014-01-03 20:08:05 +01:00
testdata parsing todo.txt done 2014-01-03 20:00:40 +01:00
.gitignore Initial commit 2014-01-02 15:04:33 -08:00
.travis.yml added travis-ci build status 2014-01-03 20:08:05 +01:00
LICENSE initial commit, begin working on library 2014-01-03 01:29:54 +01:00
README.md added travis-ci build status 2014-01-03 20:08:05 +01:00
todo.txt work in progress 2014-01-03 17:35:38 +01:00
todotxt.go parsing todo.txt done 2014-01-03 20:00:40 +01:00
todotxt_test.go parsing todo.txt done 2014-01-03 20:00:40 +01:00

README.md

go-todotxt

A Go todo.txt library.

GoDoc Build Status

The todotxt package is a Go client library for Gina Trapani's todo.txt files. It allows for parsing and manipulating of task lists and tasks in the todo.txt format.

Installation

$ go get github.com/JamesClonk/go-todotxt

Requirements

go-todotxt requires Go1.1 or higher.

Usage

	package main

	import (
		"fmt"
		"github.com/JamesClonk/go-todotxt"
		"log"
	)

	func main() {
		todotxt.IgnoreComments = false

		tasklist, err := todotxt.LoadFromFilename("todo.txt")
		if err != nil {
			log.Fatal(err)
		}

		fmt.Printf("Task 2, todo: %v\n", tasklist[1].Todo)
		fmt.Printf("Task 3: %v\n", tasklist[2])
		fmt.Printf("Task 4, has priority: %v\n\n", tasklist[3].HasPriority())
		fmt.Print(tasklist)
	}

Documentation

See GoDoc - Documentation for further documentation.

License

The source files are distributed under the Mozilla Public License, version 2.0, unless otherwise noted.
Please read the FAQ if you have further questions regarding the license.