Improved documentation

README.md

@@ -5,3 +5,44 @@
 BadIO is a Go package which contains extensions to Go's
 [testing/iotest](https://golang.org/pkg/testing/iotest/) package which
 implements Readers and Writers useful mainly for testing.
+
+
+## Installation
+
+	$ go get github.com/cavaliercoder/badio
+
+
+## Example
+
+```go
+r := badio.NewSequenceReader([]byte("na"))
+
+p := make([]byte, 20)
+r.Read(p)
+
+fmt.Printf("ba%s\n", p)
+
+// Prints: banananananananananana
+
+```
+
+## License
+
+Copyright (c) 2015 Ryan Armstrong
+
+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.

doc.go

@@ -0,0 +1,5 @@
+/*
+BadIO is a Go package which contains extensions to Go's testing/iotest package
+which implements Readers and Writers useful mainly for testing.
+*/
+package badio