Skip to content

Commit

Permalink
add usage to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
natesales committed Jan 3, 2021
1 parent a7cd0ce commit fd5a803
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# birdrs

[![Go Report](https://goreportcard.com/badge/github.com/natesales/birdrs?style=for-the-badge)](https://goreportcard.com/report/github.com/natesales/birdrs)
[![License](https://img.shields.io/github/license/natesales/birdrs?style=for-the-badge)](hhttps://github.com/natesales/birdrs/blob/main/LICENSE)
[![Release](https://img.shields.io/github/v/release/natesales/birdrs?style=for-the-badge)](https://github.com/natesales/birdrs/releases)

SSH route server for BIRD

### Installation

This project is available in my public code repositories. See https://github.com/natesales/repo for more info.

### Usage

```
Usage for birdrs (dev) https://github.com/natesales/birdrs:
-b string
SSH daemon bind address:port (default ":22")
-k string
SSH host key file (default "~/.ssh/id_ed25519")
-p string
path to birdc binary (default "birdc")
-v enable verbose debugging output
```

0 comments on commit fd5a803

Please sign in to comment.