tusd/README.md

# tusd

tusd is the official reference implementation of the [tus resumable upload
protocol](http://www.tus.io/protocols/resumable-upload.html).

This means it is meant for client authors to verify their implementations as
well as server authors who may look at it for inspiration.

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.

**Protocol version:** 0.1 (upgrade to 0.2 will be ready soon)

## Getting started

**Requirements:**

* [Go 1.0](http://golang.org/doc/install)

**Running tusd from source:**

Clone the git repository and `cd` into it.

```bash
git clone git@github.com:tus/tusd.git
cd tusd
```

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.

```bash
source dev.sh
```

Now you can run tusd:

```bash
go run src/cmd/tusd/main.go
```

## License

This project is licensed under the MIT license, see `LICENSE.txt`.