diff --git a/README.md b/README.md new file mode 100644 index 00000000..55300d8e --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Distributed Home File System 🚧 + +## What is this? + +Inspired by Syncthing and Google Drive File Stream, this project +aspires to combine the best of them into one complete solution for +all the file synchronization needs: being decentralized like +Syncthing and allowing you to stream your files like Google Drive File Stream + +## Run wrapper + +[Download latest build](https://nightly.link/usatiuk/dhfs/workflows/server/main/Run%20wrapper.zip) + +This is a simple wrapper around the jar/web ui distribution that allows you to run/stop +the DHFS server in the background, and update itself (hopefully!) + +## How to use it and how it works? + +TODO 😁