README.md
changeset 13 923ce3e425cd
child 14 f67da1c20c86
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat Apr 07 22:28:50 2018 +0200
@@ -0,0 +1,23 @@
+# takuzu
+
+Golang takuzu library
+
+[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/McKael/takuzu)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/McKael/takuzu/master/LICENSE)
+[![Build Status](https://travis-ci.org/McKael/takuzu.svg?branch=master)](https://travis-ci.org/McKael/takuzu)
+
+This repository contains a [Go](https://golang.org/) library package that
+provides functions to solve, build or validate takuzu puzzles.
+
+- Mercurial repository: https://hg.lilotux.net/golang/mikael/takuzu/
+- Github mirror: https://github.com/McKael/takuzu/
+
+Please read the [godoc documentation]](https://godoc.org/github.com/McKael/takuzu) for details.
+
+This project also contains a command line utility, named `gotak`, to solve or
+generate puzzles.
+I haven't written the tool documentation yet.
+
+This library is used by GotakJS, an [online takuzu puzzle game](https://lilotux.net/~mikael/takuzu/),
+written in Go using [GopehJS](https://github.com/gopherjs/gopherjs).
+(On mobile, works best with Chrome.  On a computer, I've tested it with both Firefox and Chrome.)