Skip to content

Commit

Permalink
Add get started in readme
Browse files Browse the repository at this point in the history
Signed-off-by: Yilun <zyl.skysniper@gmail.com>
  • Loading branch information
yilunzhang committed Nov 13, 2019
1 parent 5266211 commit 43bf334
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,19 @@ have a public IP address. All connections are outbound instead of inbound. This
makes nshd even more secure and convenient.

4. Cross platform compatibility: It just takes a few lines of code to send
commands and receive results in any language supporting NKN client SDK. It is
worth mentioning that [d-chat](http://gitlab.com/losnappas/d-chat) is natively
compatible to nshd without any modification.
commands and receive results in any language supporting NKN client SDK.

## Get Started

The fastest way to get started is to run `nshd` with `--session` argument and
use one of the following client:

* [http://nsh.nkn.org](http://nsh.nkn.org) (source: [nkn-shell-client-xterm](https://github.com/nknorg/nkn-shell-client-xterm))

* [d-chat](http://gitlab.com/losnappas/d-chat) private message

But you still need to add your client public key to `authorized_pubkeys`, see
the next section.

## Configurations

Expand Down

0 comments on commit 43bf334

Please sign in to comment.