From 55e4f729c6ba1f49722624979e761ddef15671e3 Mon Sep 17 00:00:00 2001 From: Samuel Freiberg Date: Sat, 24 Feb 2018 21:52:49 -0800 Subject: [PATCH] Update README --- README.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cf2d41b..086b0c8 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,25 @@ -simplessh -========= +# simplessh +[![GoDoc](https://godoc.org/github.com/sfreiberg/simplessh?status.png)](https://godoc.org/github.com/sfreiberg/simplessh) SimpleSSH is a simple wrapper around go ssh and sftp libraries. -License -======= +## Features +* Multiple authentication methods (password, private key and ssh-agent) +* Sudo support +* Simple file upload/download support -SimpleSSH is licensed under the MIT license. - -Installation -============ +## Installation `go get github.com/sfreiberg/simplessh` -Documentation -============= -[GoDoc](http://godoc.org/github.com/sfreiberg/simplessh) - -Example -======= +## Example ``` package main import ( - "github.com/sfreiberg/simplessh" - "fmt" + + "github.com/sfreiberg/simplessh" ) func main() { @@ -47,4 +41,7 @@ func main() { fmt.Printf("Uptime: %s\n", output) } -``` \ No newline at end of file +``` + +## License +SimpleSSH is licensed under the MIT license. \ No newline at end of file