diff --git a/.github/screenshot.png b/.github/screenshot.png new file mode 100644 index 0000000..6a5744c Binary files /dev/null and b/.github/screenshot.png differ diff --git a/README.md b/README.md index e69de29..395463a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,44 @@ + +
+Screenshot + +Rclone UI is the cross platform GUI for [rclone](https://rclone.org/) +
+ +# [Rclone UI](https://rcloneui.com) + +### A light, transparent layer on top of **`rclone`** that lets you manage your remotes & tasks in a more user-friendly way. + +Free to use, open source, actively maintained and built with [Tauri](https://tauri.app/). + +## Features +- ✅ Cross platform running on Windows, Linux, macOS (x64, Arm and Apple Silicon) +- ✅ Works with your existing rclone installation (or can install rclone for you) +- ✅ File Browser +- ✅ Sync Command +- ✅ Copy Command +- ✅ Mount Command +- ✅ Jobs (see all background operations) +- ✅ Add/Remove Remotes +- ✅ Set default flags for each remote separately, based on the operation (mount, sync, copy, etc) +- ✅ Customize the flags when running an operation on a case by case basis +- ✅ Set a password for the Settings panel +- ✅ Hide commands or remotes from the tray menu + +Screenshot + +## Downloads +- Windows (**[Arm](https://get.rcloneui.com/win-arm)**, **[x64](https://get.rcloneui.com/win)**) +- Linux (**[AppImage](https://get.rcloneui.com/linux)**, **[deb](https://get.rcloneui.com/linux-deb)**, **[rpm](https://get.rcloneui.com/linux-rpm)**) +- macOS (**[Apple Silicon](https://get.rcloneui.com/mac)**, **[Intel](https://get.rcloneui.com/mac64)**) + +## Roadmap +- [ ] File Commander +- [ ] [`rclone serve`](https://rclone.org/commands/rclone_serve/) +- [ ] [`rclone link`](https://rclone.org/commands/rclone_link/) +- [ ] Mobile Client +- [ ] Autostart +- [ ] Job Templates + +## Contributing +We welcome your contributions! Please open an [issue](https://github.com/FTCHD/rclone-ui/issues/new?template=Blank+issue) or a [PR](https://github.com/FTCHD/rclone-ui/compare), and let's make it better together 🎉🎉 \ No newline at end of file