From 0c63a590334b0577fef3985c1146069f2a6502a9 Mon Sep 17 00:00:00 2001
From: Charles Iliya Krempeaux <iamreiver@gmail.com>
Date: Thu, 5 Sep 2019 18:28:37 -0700
Subject: [PATCH] initial commit

---
 LICENSE   | 19 +++++++++++++++++++
 README.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..411b0d3
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2019 Charles Iliya Krempeaux :: http://changelog.ca/
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0292152
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# go-buffers
+
+Package **buffers** provides tools for working with byte array, and byte slice buffers.
+
+## Documention
+
+Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-buffers
+
+[![GoDoc](https://godoc.org/github.com/reiver/go-buffers?status.svg)](https://godoc.org/github.com/reiver/go-buffers)
+
+## Example
+```go
+import "github.com/reiver/go-buffers"
+
+// ...
+
+var buffer [1024]byte
+
+var p []byte = buffer[:]
+
+writer := buffers.NewWriter(p)
+
+n, err := writer.Write(data)
+
+switch casted := err.(type) {
+case buffers.TooShort:
+	//@TODO
+default:
+	return err
+}
+
+```