editor-profile-sync 1.0.0 → 1.0.2

package/README.md

@@ -2,7 +2,10 @@
 
 Cross-platform CLI to share your VS Code-based editor profile between editors.
 
+[GitHub](https://github.com/sbetav/editor-profile-sync) · [npm](https://www.npmjs.com/package/editor-profile-sync)
+
 You can sync:
+
 - extensions
 - snippets
 - `settings.json`
@@ -15,33 +18,34 @@ You can sync:
 
 ## Install
 
-Clone this repo, then install dependencies:
+### Via npx (recommended)
+
+Run directly without installing:
 
 ```bash
-npm install
+npx editor-profile-sync
 ```
 
-## Usage
+### Global install
 
-From the project folder:
+Install once, then run from anywhere:
 
 ```bash
-npm start
+npm install -g editor-profile-sync
+editor-profile-sync
 ```
 
-or:
+### From source
 
-```bash
-node index.js
-```
-
-After linking (`npm link` in this folder), run from anywhere:
+Clone this repo, then install dependencies:
 
 ```bash
-editor-profile-sync
+npm install
 ```
 
-### Options
+## Usage
+
+### CLI options
 
 | Option            | Description         |
 | ----------------- | ------------------- |
@@ -73,11 +77,12 @@ For `settings.json`, each target is merged as:
 ```js
 const merged = {
   ...targetSettings,
-  ...sourceSettings
-}
+  ...sourceSettings,
+};
 ```
 
 What this means:
+
 - Shared/source settings win on key conflicts.
 - Existing unrelated target settings stay.
 - Editor-specific keys are preserved unless your source uses the same key.

package/index.js

@@ -5,6 +5,7 @@ import { dirname, join } from "path";
 import { fileURLToPath } from "url";
 import ora from "ora";
 import chalk from "chalk";
+import updateNotifier from "update-notifier";
 import {
   EDITORS,
   EXTENSION_MODES,
@@ -33,6 +34,9 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 const pkg = JSON.parse(readFileSync(join(__dirname, "package.json"), "utf-8"));
 
+const notifier = updateNotifier({ pkg });
+notifier.notify();
+
 async function main() {
   const args = process.argv.slice(2);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "editor-profile-sync",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Cross-platform extensions, settings.json, and snippets sync for VS Code-based editors",
   "type": "module",
   "main": "index.js",
@@ -27,6 +27,7 @@
   ],
   "author": "sbetav",
   "license": "MIT",
+  "repository": "github:sbetav/editor-profile-sync",
   "engines": {
     "node": ">=18"
   },
@@ -34,6 +35,7 @@
     "chalk": "^5.6.2",
     "inquirer": "^9.2.22",
     "jsonc-parser": "^3.3.1",
-    "ora": "^9.3.0"
+    "ora": "^9.3.0",
+    "update-notifier": "^7.3.1"
   }
-}
+}