Termbox is a library that provides a minimalistic API which allows the
programmer to write text-based user interfaces. The library is crossplatform
and have both terminal-based implementations on *nix operating systems and
winapi console based implementation on windows operating system. The basic
idea is an abstraction of the greatest common subset of features available
on all major terminals and other terminal-like APIs in a minimalistic fashion.
Small API means it is easy to implement, test, maintain and learn it, that's
what makes the termbox a distinct library in its area.

For examples of what can be done take a look at demos in the _demos directory.
You can try them out that way:
	go run _demos/keyboard.go

Also take a look at the godit, it is a text editor written using termbox, you
can find it here: https://github.com/nsf/godit

API reference:

http://gopkgdoc.appspot.com/pkg/github.com/nsf/termbox-go

## Termbox
Termbox is a library that provides a minimalistic API which allows the programmer to write text-based user interfaces. The library is crossplatform and has both terminal-based implementations on *nix operating systems and a winapi console based implementation for windows operating systems. The basic idea is an abstraction of the greatest common subset of features available on all major terminals and other terminal-like APIs in a minimalistic fashion. Small API means it is easy to implement, test, maintain and learn it, that's what makes the termbox a distinct library in its area.

### Installation
Install and update this go package with `go get -u github.com/nsf/termbox-go`

### Examples
For examples of what can be done take a look at demos in the _demos directory. You can try them with go run: `go run _demos/keyboard.go`

There are also some interesting projects using termbox-go:
 - [godit](https://github.com/nsf/godit) is an emacsish lightweight text editor written using termbox.
 - [gomatrix](https://github.com/GeertJohan/gomatrix) connects to The Matrix and displays it's data streams in your terminal.

### API reference
[godoc.org/github.com/nsf/termbox-go](http://godoc.org/github.com/nsf/termbox-go)

Update readme.md. - Add headings - Add installation guide - Add anchor to godoc.org - Changed godit example to list of examples - Add gomatrix to list of examples
Update readme.md.
 - Add headings
 - Add installation guide
 - Add anchor to godoc.org
 - Changed godit example to list of examples
 - Add gomatrix to list of examples
