-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7adc9cd
commit f81baa7
Showing
1 changed file
with
21 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,40 @@ | ||
# Cync | ||
# Cync | ||
|
||
A terminal-based user interface for hosting files on S3 with seamless file synchronization capabilities. | ||
|
||
Supports bi-directional sync without versioning. | ||
|
||
## Installation | ||
|
||
`cync` is available on [crates.io](https://crates.io/crates/cync) and can be installed by running `cargo install cync`. | ||
`cync` is available on [crates.io](https://crates.io/crates/cync) and on homebrew. | ||
|
||
To install from crates.io: | ||
|
||
``` | ||
cargo install cync | ||
``` | ||
|
||
To install from homebrew | ||
|
||
``` | ||
brew tap juicedrinker/cync | ||
brew install cync | ||
``` | ||
|
||
## Dependencies | ||
|
||
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) | ||
- Configure [AWS SSO](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html) | ||
|
||
## Usage | ||
|
||
- Run `cync init` to run the setup wizard the first time | ||
- Run `cync` to run CLI thereafter | ||
- Run `cync` to run TUI | ||
|
||
## Roadmap | ||
|
||
- Add extra CLI commands to print local and remote directory paths | ||
- Terminal restoration on panics | ||
- Improve Setup wizard | ||
- Improve Setup wizard | ||
- Improve error reporting | ||
- Add loader for long-running tasks | ||
|