Skip to content

Commit 588a046

Browse files
committed
Add screenshot and future plans to readme
1 parent 3cb066a commit 588a046

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22

33
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1c341468220446a4a7b5207eedec044c)](https://app.codacy.com/app/sean_13/s3-sync-tool?utm_source=github.com&utm_medium=referral&utm_content=seanvm/s3-sync-tool&utm_campaign=badger)
44

5-
This is an Electron/ReactJS desktop app that provides a UI for easily syncing S3 buckets. It primarily utilizes the AWS CLI for its core functionality.
5+
This is an Electron/ReactJS desktop app that provides a UI for easily downloading S3 buckets. It primarily utilizes the AWS CLI for its core functionality.
66

77
This is a WIP, and as such is very limited in functionality, and may contain bugs. Do not use this to sync production s3 buckets.
88

9+
<p align="center">
10+
<img src="./screenshot.png" alt="S3 Bucket Download Tool UI"
11+
width="900px">
12+
</p>
13+
914
## Requirements
10-
- You must have the [AWS CLI](https://aws.amazon.com/cli/) installed and configured
15+
- You must have the [AWS CLI](https://aws.amazon.com/cli/) installed and configured.
1116
- You must have at least one Amazon s3 bucket created.
1217

1318
## Setup
@@ -35,3 +40,9 @@ This will output the packaged application to your dist folder.
3540
## Download Latest Release
3641

3742
You can download a copy of the latest version of this app (for macOS) to play around with on the [releases](https://github.com/seanvm/s3-sync-tool/releases) page of this repo.
43+
44+
## Future Plans
45+
46+
- Add the ability to configure AWS credentials directly through the app, and switch users/roles.
47+
- Add file browser for s3.
48+
- Allow for files to be uploaded to s3.

0 commit comments

Comments
 (0)