diff --git a/README.md b/README.md index 6a1034e..7f5478a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ A bash automation tool for synchronizing project files from a remote server to your local machine with automatic VS Code SFTP configuration. +## Installation + +1. Clone the project +2. Add it with symbolic link to all mtc. project folder and call it + +```sh +ln -s ~/Documents/GitHub/mtc-project-sync-script/sync-project.sh . +``` + +3. Call it with `./sync-project.sh` and enter needed credentials + ## Overview **MTC Sync Script** streamlines the process of downloading and setting up projects from remote servers. It automates: @@ -142,4 +153,4 @@ This script is provided as-is for development and synchronization purposes. ## Contributing -Feel free to improve this script or report issues! \ No newline at end of file +Feel free to improve this script or report issues!