Add README and license.

[greproxy] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..634d054
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+Provisional README
+
+greproxy is a daemon to turn an unreliable GRE tunnel (e.g. over
+the open Internet) into a more reliable one; instead of
+
+  A -> Internet -> B,
+
+do
+
+  A -> greproxy -> Internet -> greproxy -> B
+
+It is primarily useful for UDP video streams (e.g. multicast); it is not very
+well tuned for anything else.
+
+Primary features:
+
+ - Talks standard GRE, e.g. with Cisco or Juniper equipment.
+ - Can reorder packets (within reason), based on GRE sequence numbers.
+ - Forward error correction (through fecpp) using Reed-Solomon;
+   can handle a certain amount of packet loss without any more ill
+   effects than increased jitter. (Only works when talking to another
+   greproxy, not other GRE devices.)
+ - Can also work as a Linux tun device, instead of proxying to GRE.
+ - IPv6.
+
+greproxy is licensed under the GNU General Public License, version 2.
+See the file COPYING.
+
+Contact: Steinar H. Gunderson <sgunderson@bigfoot.com>