summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Carrillo <ben@futeisha.org>2013-02-05 23:00:53 +0900
committerBen Carrillo <ben@futeisha.org>2013-02-05 23:00:53 +0900
commit4c5f597132a0db4418b18b42385dde7f860afcb0 (patch)
tree2796b4bbd8d95552cd839235532bde82a461d8fe /README.md
initial commit1.07-1
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..25ad1de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+sh (previously [pbs](http://pypi.python.org/pypi/pbs)) is a full-fledged
+subprocess interface for Python 2.6 - 3.2
+that allows you to call any program as if it were a function:
+
+```python
+from sh import ifconfig
+print ifconfig("eth0")
+```
+
+sh is not a collection of system commands implemented in Python.
+
+# Installation
+
+ $> pip install sh
+
+# Complete documentation @ http://amoffat.github.com/sh