Update README.md

This commit is contained in:
Benjamin Toby
2024-10-16 06:50:00 +01:00
parent 881fff00e4
commit 727beb0760
2 changed files with 14 additions and 7 deletions
+11 -3
View File
@@ -8,19 +8,27 @@ Turbo sync requires **node js** and **rsync**
## Installation
To install simply run:
```bash
npm install --registry="https://git.tben.me/api/packages/Moduletrace/npm/" -g turbo-sync
npm install --registry="https://git.tben.me/api/packages/Moduletrace/npm/" -g turbosync
```
To update run:
```bash
npm update --registry="https://git.tben.me/api/packages/Moduletrace/npm/" -g turbosync
```
## Usage
```bash
turbo-sync ./turbosync.config.json
turbosync ./turbosync.config.json
```
### Config File
The config file is a json file that contains all the information needed to run turbo-sync. Example:
The config file is a json file that contains all the information needed to run turbosync. Example:
```json
[