added readme and screenshot

buggyzap · Nov 10, 2022 · 2e366ca · 2e366ca
1 parent 66b8793
commit 2e366ca
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# FTP Transfer Watcher App
+
+![Desktop app screenshot](screenshot.png)
+
+Source of Electon Desktop app to synchronize changes in local folder to FTP remote server.
+
+Any files added or changed in a **source** folder, we're moved to Remote FTP and moved to backup folder.
+
+## Use cases
+
+You will need it in case you want to keep a remote folder updated via FTP from a local folder, like system integrations solutions.
+
+## Contribute or use it
+
+Clone the repo, install dependecies and run
+`npm start`
+
+## Download
+
+Soon I will publish compiled package for Windows, Linux and MacOS
diff --git a/screenshot.png b/screenshot.png