Skip to content

Commit 31e5db3

Browse files
Fix: ReadME
1 parent 7544644 commit 31e5db3

File tree

2 files changed

+46
-7
lines changed

2 files changed

+46
-7
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Go Test
1+
name: Go
22

33
on:
44
pull_request:

README.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,55 @@
1+
<!-- markdownlint-configure-file {
2+
"MD013": {
3+
"code_blocks": false,
4+
"tables": false
5+
},
6+
"MD033": false,
7+
"MD041": false
8+
} -->
9+
10+
<div align="center" markdown="1">
11+
112
# Bridgeftp
213

14+
[![Tests](https://github.com/abhijeetmohanan/bridgeftp/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/abhijeetmohanan/bridgeftp/actions/workflows/test.yml/badge.svg?query=branch%3Amain)
15+
![GitHub Release](https://img.shields.io/github/v/release/abhijeetmohanan/bridgeftp)
16+
17+
<br/>
18+
19+
</div>
20+
21+
## About
22+
323
A tool that can copy files from Remote to Remote FTP Servers
424

5-
## Supports
25+
* It streams data from source to destination [ no need to save files locally just to transfer ]
26+
27+
* Supported Protocols
28+
* ftp
29+
* sftp
630

7-
- ftp
8-
- sftp
31+
## Installation
32+
33+
**1: Binary Installation**
34+
35+
download one of [releases](https://github.com/abhijeetmohanan/bridgeftp/releases)
36+
37+
## Getting Started
38+
39+
<b> FTP </b>
40+
41+
```bash
42+
bridgeftp --src ftp://username:password@server:port/filepath \
43+
--dest ftp://username@password@server:port/filepath \
44+
--bs 512
45+
```
946

10-
## Usage
47+
<b> SFTP </b>
1148

1249
```bash
13-
bridgeftp --src ftp://username:password@server:port/filepath --dest ftp://username@password@server:port/filepath
50+
bridgeftp --src sftp://username:password@server:port/filepath \
51+
--dest sftp://username@password@server:port/filepath \
52+
--bs 512
1453
```
1554

16-
**change the protocol to switch between sftp and ftp
55+
##

0 commit comments

Comments
 (0)