Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
* add badges
* add usage block
  • Loading branch information
alebabai committed Jul 11, 2019
1 parent 85f496a commit db6daf0
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# ssh-proxy
Dockerized ssh-proxy
# SSH-proxy

> Dockerized ssh-proxy powered by OpenSSH
[![](https://images.microbadger.com/badges/image/alebabai/ssh-proxy.svg)](https://microbadger.com/images/alebabai/ssh-proxy "Get your own image badge on microbadger.com")
[![](https://images.microbadger.com/badges/version/alebabai/ssh-proxy.svg)](https://microbadger.com/images/alebabai/ssh-proxy "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/license/alebabai/ssh-proxy.svg)](https://microbadger.com/images/alebabai/ssh-proxy "Get your own license badge on microbadger.com")

## Usage

### Environment variables

- `ADDRESS` - _provide one or more `HOST:PORT` pairs separated by space for services to be exposed_

### Docker

Here is docker-compose example configuration [`docker-compose.example.yml`](docker-compose.example.yml).

0 comments on commit db6daf0

Please sign in to comment.