Skip to content

Commit

Permalink
README editing
Browse files Browse the repository at this point in the history
  • Loading branch information
kontsevoy committed Mar 24, 2016
1 parent a341dc9 commit 2f823db
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ practices:
Teleport is built on top of the high-quality [Golang SSH](https://godoc.org/golang.org/x/crypto/ssh)
implementation and it is fully compatible with OpenSSH.

## Installing and Running

Download the latest binary release, unpack the .tar.gz and run `sudo make install`.
This will copy Teleport binaries into `/usr/local/bin` and the web assets
to `/usr/local/share/teleport`.

Then you can run Teleport as a single-node cluster:

```
teleport start
```

## Why Build Teleport?

Mature tech companies with significant infrastructure footprints tend to implement most
Expand Down Expand Up @@ -47,7 +59,8 @@ The best way to contribute is to create issues or pull requests right here on Gi
### Building

Teleport is written in Go. If you have Golang 1.5 and newer, simply clone this repository
and run `make`. You'll have to create `/var/lib/teleport` directory and then you can start Teleport as a single-node cluster in development mode: `build/teleport start -d`
and run `make`. You'll have to create `/var/lib/teleport` directory and then you can start
Teleport as a single-node cluster in development mode: `build/teleport start -d`

## Status

Expand Down

0 comments on commit 2f823db

Please sign in to comment.