diff --git a/README.md b/README.md index dbe595d..76a7d3f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,12 @@ ### Features - Sync files to and from a single S3 bucket. - Configure multiple directories to be synced to S3. -- Currently, the functionality is only provided via running the CLI manually. This works for my use case, but is definitely not ideal. +- Currently, the functionality is only provided via running the binary manually. This works for my use case, but is definitely not ideal. +### Installation +Currently, only installation with `cargo` is supported. This will install the executable to `$HOME/.cargo/bin/s3-sync`. +```sh +cargo install --git https://github.com/cloud303-cholden/rs-s3-sync +``` ### Example Configuration The TOML configuration location must either be `$S3_SYNC_CONFIG` or `$XDG_CONFIG_HOME/s3-sync/config.toml`. Below is a sample configuration file. ```toml @@ -25,5 +30,6 @@ profile = "aws-profile" # AWS profile name. If not specified, AWS credential - The decision to either download or upload is done by comparing the last modified date of a file both locally and in S3. This is very quick to check, but a more robust implementation might also compare the file hashes. - Need logic for handling deletion of files both locally and in S3. One example scenario is whether deleting a file locally should prevent it from being downloaded when the next sync is run. - Add difference calculation. -- Add a service for automatically watching for file changes. +- Add a service for automatically watching for file changes. Move core logic to library. +- Change the binary to an actual CLI. - Add support for changing configuration settings with CLI.