diff --git a/README.md b/README.md index e69de29..a6ade27 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,25 @@ +jsh +=== + +An augmented Unix userland. Makes your core utility functions a bit cooler by +adding a --json flag that makes everything output in nice, serialized JSON. + +## Assumptions + +* You have the following binaries (usually found in your distro's coreutils + packages) + * /usr/bin/ps +* You have Go installed + +We're working on making it so that they don't have to be in those directories. + +## Installing + +* git clone this directory +* cd into the directory +* set the GOPATH environment variable to the directory + +### ps + +* $ go install "jsh/ps" +* $ bin/ps