add a readme
Some checks failed
Server / build-dhfs (push) Failing after 29m54s
Server / build-webui (push) Successful in 2m28s
Server / publish-docker (push) Has been skipped
Server / publish-run-wrapper (push) Has been skipped

This commit is contained in:
2024-07-23 21:39:41 +02:00
parent bb40b0e75b
commit 03d837a229

19
README.md Normal file
View File

@@ -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 😁