Add description

idobata · Oct 24, 2015 · 3fa8cf6 · 3fa8cf6
1 parent ab0fa18
commit 3fa8cf6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,7 +5,7 @@ authors = ["Hika Hibariya <[email protected]>"]
 repository = "https://github.com/idobata/hokaido"
 homepage = "https://github.com/idobata/hokaido"
 license="MIT"
-description='Terminal shareing tool.'
+description='Terminal sharing tool.'
 keywords = ["terminal", "tool"]
 
 [dependencies]

diff --git a/README.md b/README.md
@@ -1,18 +1,28 @@
 # Hokaido
 
-## 1. Start server (Anywhere in internet)
+Hokaido is a character based terminal sharing tool. It's speedy and clear.
+
+## How to use
+
+### 1. Start server
+
+Server is needed to relay communication between broadcaster and watchers.
 
 ``` sh
 $ hokaido server # on 203.0.113.10:4423
 ```
 
-## 2. Watch (Tokyo)
+### 2. Watch
+
+`watch` displays broadcaster's shell output.
 
 ``` sh
 $ hokaido watch --host 203.0.113.10
 ```
 
-## 3. Broadcast (Hokaido!)
+### 3. Broadcast
+
+`broadcast` invokes a new $SHELL and starts broadcasting its output.
 
 ``` sh
 $ hokaido broadcast --host 203.0.113.10