Skip to content

Commit 70ebb63

Browse files
author
Jack Tang
committed
UPT: readme and makefile
1 parent c912038 commit 70ebb63

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ build:
1414
go build cmd/tusc.go
1515

1616
clean:
17-
rm -rf tusc*
17+
rm -rf tusc* data .tusc
1818

1919
release-patch: all
2020
release-it -n -i patch

README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
[![build status](https://travis-ci.com/jackhftang/tusc.svg?branch=master)](https://travis-ci.org/jackhftang/tusc)
44

5-
A single binary for both server and client of [tus resumable upload protocol](https://tus.io).
5+
TUS **C**ommand line (tusc) is a small static binary for both server and client of [tus resumable upload protocol](https://tus.io).
66

7-
This is a wrapper of [tusd](https://github.com/tus/tusd) with nginx-like file listing page (or index page) is added.
8-
Features like S3, GCS, Prometheus, Hooks are removed from tusd, in favor of smaller binary size (< 5 MB after upx-ed rather than > 30MB raw).
9-
This is a command line implementation this library [go-tusd](https://github.com/eventials/go-tus).
7+
Personally, I need tusc for uploading files in a CI process and a simple UI for downloading (like nginx autoindex).
8+
The chucked and resumable feature make it possible to bypass some payload size limitation imposed by proxy.
9+
Also, small size of binary make it convenient to be included in docker image.
1010

1111
## Quick Start
1212

@@ -33,8 +33,12 @@ $ tusc client http://127.0.0.1:8080/files/ text.txt -r # resumable
3333

3434
And then visit to [file listing page](http://127.0.0.1:8080)
3535

36-
### Server Options
36+
### Server
3737

38+
TUSC is a wrapper of [tusd](https://github.com/tus/tusd) with and addition of a listing page.
39+
Features like S3, GCS, Prometheus, Hooks are removed from tusd, in favor of smaller binary size.
40+
41+
#### Options
3842

3943
```
4044
$ tusc s --help
@@ -58,7 +62,11 @@ Options:
5862
--behind-proxy Respect X-Forwarded-* and similar headers which may be set by proxies [default: false]
5963
```
6064

61-
### Client Options
65+
### Client
66+
67+
TUSC is a command line implementation of this excellent library [go-tusd](https://github.com/eventials/go-tus).
68+
69+
#### Options
6270

6371
```
6472
$ tusc c --help
@@ -74,3 +82,6 @@ Options:
7482
--chuck-size BYTE Size of chucks of file [default: 2097152]
7583
--override-patch-method Sending a POST request instead of PATCH [default: false]
7684
```
85+
86+
87+

0 commit comments

Comments
 (0)