Skip to content

Commit db6daf0

Browse files
committed
docs: update readme
* add badges * add usage block
1 parent 85f496a commit db6daf0

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
1-
# ssh-proxy
2-
Dockerized ssh-proxy
1+
# SSH-proxy
2+
3+
> Dockerized ssh-proxy powered by OpenSSH
4+
5+
[![](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")
6+
[![](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")
7+
[![](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")
8+
9+
## Usage
10+
11+
### Environment variables
12+
13+
- `ADDRESS` - _provide one or more `HOST:PORT` pairs separated by space for services to be exposed_
14+
15+
### Docker
16+
17+
Here is docker-compose example configuration [`docker-compose.example.yml`](docker-compose.example.yml).

0 commit comments

Comments
 (0)