diff --git a/README.md b/README.md index 64d29ef..7543f52 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,21 @@ It's just a simple deployment. You may need it for something more. **Portable pr *Apps configurations are restored individually, I made them for myself, keep in mind! Everything written here may be a very **unprepared solution** for you!* -# What it all does +This project lets you store app data in a single folder and automatically create symlinks to restore configurations. -1. Install Chocolatey (and maybe Winget, Scoop) -2. Install Chocolatey and Winget packages (exported lists) -3. Install program Symlinks *and other...* +## Overview -In the settings, you can change the path variables. +* Simple apps use `from` and `to` columns in a CSV for linking. +* Isolated apps have separate `connect` and `disconnect` scripts in `isolated/` folder. +* Module `apps-data-manager` provides three functions: + + 1. `connect` — creates symlinks. + 2. `disconnect` — removes symlinks. + 3. `reconnect` — disconnects and reconnects. + +## Features + +* Add simple symlinks by adding a line to the CSV. +* Fully automated via PowerShell; no extra software required. + +> ⚠️ Note: Isolated app scripts are custom and may require adjustments.