commit 70b23193e8ca4284dfcac3b9a8e007620121bcbe parent 29faa2ce60140cf199d65e8b73994509972e83be Author: Erik Loualiche <eloualiche@users.noreply.github.com> Date: Sun, 4 May 2025 09:59:13 -0500 Merge pull request #2 from eloualiche/feature/2fa-authentication some more readme Diffstat:
| M | readme.md | | | 48 | +++++++++++++++++++++++++++++++++++++++++++----- |
1 file changed, 43 insertions(+), 5 deletions(-)
diff --git a/readme.md b/readme.md @@ -1,6 +1,45 @@ -Usage +# esync -quick sync from one folder to a remote ... +A basic file sync tool based on watchdog/watchman and rsync. + +Tested for rsync version 3.4.1 and python >=3.9. +For more information on rsync and options, visit the [manual page.](https://linux.die.net/man/1/rsync) + + +## Installation + +With pip +```bash +git clone https://github.com/eloualic/esync.git +cd esync +pip install -e . +``` + +## Usage + +### Configuration + +To create a configuration file, run the following command: ```bash -esync sync -q -l ./local -r user@host:/path -```- \ No newline at end of file +esync init --help +``` + +### Basic command + +Local sync +```bash +esync sync -l test-sync/source -r test-sync/target +``` + +Remote sync +```bash +esync sync -l test-sync/source -r user@remote:/path/to/target +esync sync -l test-sync/source -r remote:/path/to/target # or based on ssh config +``` + + +## Future + +- Two step authentication +- Statistics +- General option for rsync