From 727beb0760239e8dac6a838c0a945543c7d548ca Mon Sep 17 00:00:00 2001 From: Benjamin Toby Date: Wed, 16 Oct 2024 06:50:00 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++--- package.json | 7 +++---- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cee10d3..c170ebc 100644 --- a/README.md +++ b/README.md @@ -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 [ diff --git a/package.json b/package.json index fc74551..ce283bb 100644 --- a/package.json +++ b/package.json @@ -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"