diff --git a/README.md b/README.md new file mode 100644 index 0000000..46dd4c2 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +

+ +

+ +FreeTubeSync is an Open API, Single User, synchronization REST server to allow for synchronization of data +between machines. + +## What you can sync: +* Watch History +* Profiles / Subscriptions +* Settings +* Playlists +* Search History + +# Setup + +To setup the API server, simple create a docker compose file with contents below, and run docker `compose up -d` + +```yaml +services: + freetubesync: + image: forge.eumario.dev/eumario/freetubesync:latest + ports: + - "8080:8080" + volumes: + - ./data:/data +``` + +This project is currently only setup to be a Single User instance, no login/account system currently +exists within the project setup. If you want Multi-User support, it's best to create multiple docker +containers for each user you want to have this capability for.