]> prime8.dev >> repos - ttyd.git/commitdiff
[ci skip] Update README.md
authorShuanglei Tao <tsl0922@gmail.com>
Fri, 16 Sep 2016 08:33:15 +0000 (16:33 +0800)
committerShuanglei Tao <tsl0922@gmail.com>
Fri, 16 Sep 2016 08:57:14 +0000 (16:57 +0800)
README.md

index 648bdcf167d8137d3b07e01f86d03657e3472865..0cf80017332b86aabdc465119ebec849f19a1ad7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,12 +17,11 @@ ttyd is a simple command line tool for sharing terminal over the web, inspired b
 
 ### For Mac OS X users
 
+Install with [homebrew](http://brew.sh):
+
 ```bash
-brew install cmake openssl json-c libwebsockets
-git clone https://github.com/tsl0922/ttyd.git
-cd ttyd && mkdir build && cd build
-cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl ..
-make
+brew tap tsl0922/ttyd
+brew install ttyd --HEAD
 ```
 
 ### For Linux users
@@ -34,11 +33,9 @@ sudo apt-get install cmake libwebsockets-dev libjson-c-dev libssl-dev
 git clone https://github.com/tsl0922/ttyd.git
 cd ttyd && mkdir build && cd build
 cmake ..
-make
+make && make install
 ```
 
-The `ttyd` executable file will be in the `build` directory.
-
 # Usage
 
 ```
@@ -62,7 +59,14 @@ OPTIONS:
     --help, -h              Print this text and exit
 ```
 
-ttyd starts web server at port `7681` by default. When you open <http://localhost:7681>, the `command` will be started with `options` as arguments and now you can see the running command on the web! :tada: 
+ttyd starts web server at port `7681` by default, the `command` will be started with `arguments` as options. For example, run:
+
+```bash
+ttyd bash
+```
+Then open <http://localhost:7681>, now you can see and control the `bash` console on your web broswer! :tada: 
+
+> **TIP:** You may replace `bash` with `login` to get a login prompt first.
 
 # Credits