First version

README.md

@@ -0,0 +1,36 @@
+# bwlcat
+## Introduction
+
+A small cat like program with a bandwidth limit.
+
+This program sends every period T N bytes.
+
+This is useful for transfering large files over slow links without causing
+a congestion.
+
+## Usage
+
+```
+bwlcat [-h] [-b <bytes>] [-t <time>] [<files>]
+
+  -h: Help
+  -b <bytes>: Sent each time N Bytes
+  -h <time>: Wait T seconds after each packet
+
+```
+
+## Example
+### Simple example
+
+```bash
+bwlcat -b 8 -t 2 /etc/hosts
+```
+
+Sent's /etc/hosts woth a speed of 4 bytes a second.
+
+### Usage to transfer a file over ssh
+```bash
+ssh remote bwlcat -b 1400 -t 1.5 /bin/bash >/tmp/bash
+```
+
+Sent over bash with 1KB/sec.