From 1a20cc047e38fceb615488374a19f6a0511e56c8 Mon Sep 17 00:00:00 2001 From: tgic Date: Wed, 17 Dec 2014 17:08:04 +0800 Subject: [PATCH] update api doc link --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1eb7d7af..c57163a2 100644 --- a/README.md +++ b/README.md @@ -218,10 +218,15 @@ This is useful when you want use publickey and something like [google-authentica you can configure the rule at `/etc/pam.d/sshpiperd` -## API +## API @ [Godoc](https://godoc.org/github.com/tg123/sshpiper/ssh#SSHPiperConfig) -sshpiper use a [modified version](ssh) of [golang.org/x/crypto/ssh](http://golang.org/x/crypto/ssh). -[sshpiperd](sshpiperd) now is the front-end of the modified ssh. +Package ssh in sshpiper is compatible with[golang.org/x/crypto/ssh](http://golang.org/x/crypto/ssh). +All func and datatype left unchanged. You can use it like [golang.org/x/crypto/ssh](http://golang.org/x/crypto/ssh). + +SSHPiper addtional API + + * [NewSSHPiperConn](https://godoc.org/github.com/tg123/sshpiper/ssh#NewSSHPiperConn) + * [SSHPiperConfig](https://godoc.org/github.com/tg123/sshpiper/ssh#SSHPiperConfig) ## TODO List @@ -229,7 +234,6 @@ sshpiper use a [modified version](ssh) of [golang.org/x/crypto/ssh](http://golan * deb package * live upgrade * unit test - * API doc * man page * hostbased auth support * ssh-copy-id support or tools