From 024a0aa4cf5ddb62ee12fca9af3a63aa4666dbd1 Mon Sep 17 00:00:00 2001
From: "Stephen McQuay (smcquay)" <stephen@mcquay.me>
Date: Mon, 22 Aug 2016 18:29:51 -0700
Subject: [PATCH] added readme

---
 readme.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..b1c60fc
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,29 @@
+# lim
+
+this is a simple cli to limit a stream of bytes by a certain number.
+
+
+## installation
+
+use `go get` to install:
+
+    go get mcquay.me/lim
+
+
+## example usage
+
+if you install the trash utility:
+
+    go install mcquay.me/trash
+
+then pipe its output:
+
+```bash
+$ trash | lim > trash.dat
+$ ls -lah trash.dat
+-rw-r--r--  1 sm  staff   1.0M Aug 22 18:28 trash.dat
+
+$ trash | lim 1gi > trash.dat
+$ ls -lah trash.dat
+-rw-r--r--  1 sm  staff   1.0G Aug 22 18:28 trash.dat
+```