aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBin Jin <bjin@ctrl-d.org>2017-03-13 14:01:22 +0800
committerBin Jin <bjin@ctrl-d.org>2017-03-13 14:01:22 +0800
commitb4643372d74357d0370d77b58e03f05ba1ffa29b (patch)
tree040527881a51175fc7f6f2cbfb7c9073d42d8043
parentREADME: add utun device information (diff)
downloadwireguard-hs-b4643372d74357d0370d77b58e03f05ba1ffa29b.tar.xz
wireguard-hs-b4643372d74357d0370d77b58e03f05ba1ffa29b.zip
README: more details with stack, minor changes
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index adba1d0..198af46 100644
--- a/README.md
+++ b/README.md
@@ -6,17 +6,18 @@ a fast, modern and secure VPN based on [Noise](https://noiseprotocol.org/) proto
Only Linux and macOS are supported at this moment.
-To build **nara**, download and install [haskell-stack](https://github.com/commercialhaskell/stack) first.
+To build **nara**, download and install [haskell-stack](https://www.haskellstack.org) first.
~~~
-$ stack setup
+$ stack setup # This will download and install GHC in a sandboxed environment,
+ # optional if stack has been configured to use global GHC.
$ stack install
~~~
### Usage
The following command will create a TUN device named `wg0` and then daemonize
-to background. Note that on macOS, the device name has to be like
-`utun1` or `utun2`. Root privilege is also required.
+to background. On macOS, the device name has to be like `utun1` or `utun2`.
+Root privilege is also required.
~~~
# nara wg0
~~~