Skip to content

Commit

Permalink
Update readme info for tusd
Browse files Browse the repository at this point in the history
  • Loading branch information
felixge committed May 2, 2013
1 parent 50dae8f commit 02d0491
Showing 1 changed file with 9 additions and 34 deletions.
43 changes: 9 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,16 @@
# tusd - Let's fix file uploading
# tusd

It's 2013, and adding reliable file uploading to your app is still too damn
hard. tus is an open source project dedicated to create the best file uploading
protocol, server and clients.
tusd is the official reference implementation of the [tus resumable upload
protocol](http://www.tus.io/protocols/resumable-upload.html).

Sounds interesting? Get notified when it's ready: http://tus.io/
This means it is meant for client authors to verify their implementations as
well as server authors who may look at it for inspiration.

## Roadmap
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.

The initial goal for this project to come up with a good and simple solution
for resumable file uploads over http.

* Defining a good http API (first proposal created)
* Implementing a minimal and robust server for it (in progress)
* Creating an HTML5 client (in progress, proof of concept working)
* Setting up an online demo (done)
* Integrating Amazon S3 for storage
* Creating an iOS client

Future features will be based on [your
feedback](https://github.com/tus/tusd/issues/new). A few potential ideas:

* Alternative transfer mechanisms: FTP, UDP, E-Mail, etc.
* Security: Authentication Tokens, HTTPS, etc.
* Support for running tusd instances in a geographically distributed cluster
(reverse CDN)
* Alternative storage backends: Cloud Files, Dropbox, etc.
* More clients: Android, PhoneGap, etc.
* Service integrations: Transloadit, Zencoder, Encoding.com, Youtube, Vimeo, Facebook, AWS
Transcoder, etc.
* File meta data analysis
* Thumbnail generation

Once the project matures, we hope to offer a hosted service and support
contracts. However, all code will continue to be released as open source, and
you'll always be able to run your own deployments easily. There will be no bait
and switch.
**Protocol version:** 0.1 (upgrade to 0.2 will be ready soon)

## Getting started

Expand Down

0 comments on commit 02d0491

Please sign in to comment.