Moduletrace/turbo-sync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
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
[

7
package.json
View File

@ -1,6 +1,6 @@
{
"name": "turbo-sync",
"version": "1.0.0",
"name": "turbosync",
"version": "1.1.0",
"module": "index.js",
"scripts": {
"start": "node index.ts",
@ -8,10 +8,9 @@
"dev": "node index.js --watch"
},
"bin": {
"turbo-sync": "./index.js",
"turbosync": "./index.js"
},
"description": "To install dependencies:",
"description": "Sync files and directories with ease",
"main": "index.js",
"author": "Benjamin Toby",
"license": "ISC"