Skip to content

Commit

Permalink
added config descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
YashishDua authored Sep 7, 2019
1 parent b009bd2 commit cc6f466
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ go get github.com/yashishdua/shipper

## 1. Ship in the same machine (non-TCP)

### Configuration

| Config | Description |
| --- | --- |
| Source | Source file path |
| Destination | Destination file path |
| BatchSize | Total characters to be processed in 1 concurrent batch. Default is 10000 |

```go
func main() {
shipper := shipper.NewShipper(shipper.Config{
Expand All @@ -32,6 +40,16 @@ func main() {

## 2. Ship between two machines (TCP)

### Configuration

| Config | Description |
| --- | --- |
| TCP Host | Destination host where to ship data |
| TCP Port | Destination port where to ship data |
| Source | Source file path |
| Destination | Destination file path |
| BatchSize | Total characters to be processed in 1 concurrent batch. Default is 10000 |

### TCP Source

```go
Expand All @@ -53,6 +71,8 @@ func main() {

### TCP Destination

> TCP Destination only requires file path and port
```go
func main() {
shipper := shipper.NewShipper(shipper.Config{
Expand Down

0 comments on commit cc6f466

Please sign in to comment.