From 6f67aa8950003962a197ee6c7b92be40e77977d2 Mon Sep 17 00:00:00 2001
From: Jesse Luehrs <doy@tozt.net>
Date: Tue, 23 Sep 2014 00:32:43 -0400
Subject: packaging stuff

---
 README | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..230b093
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+# termcast
+
+This module is a client for the L<http://termcast.org/> service, which allows
+broadcasting of a terminal session for remote viewing. It can be installed
+either via `pip install termcast_client` or by downloading the standalone
+binary
+[here](https://raw.githubusercontent.com/doy/python-termcast-client/master/termcast).
+
+To run it, just run `termcast`. A new shell will open, and it will start
+streaming data to the termcast server. You can view the contents by following
+the instructions at [termcast.org](http://termcast.org/).
+
+## Detailed Usage
+
+    termcast [--host <host>] [--port <port>] [--username <username>]
+             [--password <password>] [command...]
+
+* `--host` defaults to `noway.ratry.ru`
+* `--port` defaults to `31337`
+* `--username` defaults to the contents of `$USER`
+* `--password` defaults to asdf
+* the command defaults to the contents of `$SHELL`, or `/bin/sh` if not set
-- 
cgit v1.2.3