tusd/README.md

54 lines
1.1 KiB
Markdown
Raw Normal View History

2013-05-02 12:48:04 +00:00
# tusd
2013-03-16 21:23:25 +00:00
2013-05-02 12:48:04 +00:00
tusd is the official reference implementation of the [tus resumable upload
protocol](http://www.tus.io/protocols/resumable-upload.html).
2013-03-16 21:23:25 +00:00
2013-05-02 12:48:04 +00:00
This means it is meant for client authors to verify their implementations as
well as server authors who may look at it for inspiration.
2013-03-16 23:36:51 +00:00
2013-05-02 12:48:04 +00:00
In the future tusd may be extended with additional functionality to make it
suitable as a standalone production upload server, but for now this is not a
priority.
2013-03-16 21:25:33 +00:00
2013-05-21 08:30:05 +00:00
**Protocol version:** 0.2.1
2013-03-16 21:23:25 +00:00
2013-03-17 15:45:09 +00:00
## Getting started
**Requirements:**
2013-03-20 13:02:24 +00:00
* [Go 1.0](http://golang.org/doc/install)
2013-05-02 13:28:22 +00:00
**Running tusd from source:**
2013-03-20 13:02:24 +00:00
Clone the git repository and `cd` into it.
```bash
git clone git@github.com:tus/tusd.git
cd tusd
```
2013-03-17 15:45:09 +00:00
2013-05-02 13:28:22 +00:00
Next source the dev.sh file. You need to do this for each shell session you
plan to use for running tus from source. It basically configures a local gopath
for you, so you don't have to install tusd globally.
2013-03-17 15:45:09 +00:00
2013-05-02 13:28:22 +00:00
```bash
source dev.sh
```
Now you can run tusd:
2013-03-17 15:45:09 +00:00
```bash
2013-05-08 12:10:13 +00:00
go run src/cmd/tusd/main.go
2013-03-17 15:45:09 +00:00
```
## Running the testsuite
```bash
cd src/http
go test -v .
```
2013-03-16 21:23:25 +00:00
## License
2013-04-16 10:26:29 +00:00
This project is licensed under the MIT license, see `LICENSE.txt`.