From 48892840160584d73ea3643d5f2e286aae7fc7b0 Mon Sep 17 00:00:00 2001 From: Ambrose Chua Date: Mon, 24 May 2021 00:53:36 +0800 Subject: [PATCH] Add features section to README --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7f9237..985a00d 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,24 @@ A dropbox backed by any S3 bucket -## Buckets +## Features + +- User interface to create new dropboxes +- Store bucket credentials and settings in a Redis KV store +- Drop stored credentials when the dropbox link expires +- Upload files using S3 multipart uploads, powered by [Uppy](https://uppy.io) +- Remembers previously created dropboxes and uploaded files +- Single fat binary + +## Deploying + +To deploy as a single binary, build it from source and run: + +``` +export REDIS_CONNECTION=simple:redis-hostname:6379 +export LISTEN=:8080 +./upl +``` -It is recommended to [configure the cleanup of incomplete multipart uploads](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpu-abort-incomplete-mpu-lifecycle-config.html).