Add package descriptions for documentation

This commit is contained in:
Marius 2015-12-18 23:24:12 +01:00
parent 97f2efb6e5
commit 8d94d55320
3 changed files with 6 additions and 1 deletions

View File

@ -1,3 +1,5 @@
// Package filestore provide a storage backend based on the local file system.
//
// FileStore is a storage backend used as a tusd.DataStore in tusd.NewHandler.
// It stores the uploads in a directory specified in two different files: The
// `[id].info` files are used to store the fileinfo in JSON format. The

View File

@ -1,3 +1,4 @@
// Package tusd provides ways to accept tusd calls using HTTP.
package tusd
import (

View File

@ -1,4 +1,6 @@
// Package limitedstore implements a simple wrapper around existing
// Package limitedstore provides a storage with a limited space.
//
// This goal is achieved by using a simple wrapper around existing
// datastores (tusd.DataStore) while limiting the used storage size.
// It will start terminating existing uploads if not enough space is left in
// order to create a new upload.