new readme

README.md

@@ -0,0 +1,56 @@
+## go-tmx - Go library that reads Tiled's TMX files
+
+[![godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/salviati/go-tmx/tmx)
+
+A Go library that reads Tiled's TMX files, as described by http://doc.mapeditor.org/reference/tmx-map-format/
+
+## Installing
+
+    $ go get github.com/salviati/go-tmx/tmx
+
+You can use `go get -u` to update the package.
+
+## Basic Usage:
+
+```go
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/salviati/go-tmx/tmx"
+)
+
+const mapPath = "maps/sampleMap.tmx" // path to your map
+
+func main() {
+	r, err := os.Open(mapPath)
+
+	if err != nil {
+		fmt.Println("Error reading file")
+		os.Exit(1)
+	}
+
+	gameMap, err := tmx.Read(r) // tmx parsing
+
+	if err != nil {
+		fmt.Println("Error parsing map")
+		os.Exit(2)
+	}
+
+	fmt.Print(gameMap) // there we go! map ready!
+}
+
+```
+
+## Documentation
+
+For docs, see https://godoc.org/github.com/salviati/go-tmx/tmx or run:
+
+    $ godoc github.com/salviati/go-tmx/tmx
+
+
+## Test data info
+
+testdata/tiles.png: See http://opengameart.org/content/16x16-tiles for more information about the license of this file.

tmx/README

@@ -1,3 +1,3 @@
-A Go library that reads Tiled's TMX files, as described by https://github.com/bjorn/tiled/wiki/TMX-Map-Format 
+A Go library that reads Tiled's TMX files, as described by http://doc.mapeditor.org/reference/tmx-map-format/
 
 testdata/tiles.png: See http://opengameart.org/content/16x16-tiles for more information about the license of this file.