Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sfreiberg committed Feb 25, 2018
1 parent be2150d commit 55e4f72
Showing 1 changed file with 14 additions and 17 deletions.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -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() {
Expand All @@ -47,4 +41,7 @@ func main() {
fmt.Printf("Uptime: %s\n", output)
}
```
```

## License
SimpleSSH is licensed under the MIT license.

0 comments on commit 55e4f72

Please sign in to comment.