V1.1.0: update README.md + lowered minimum required vscode version.

.vscodeignore

@@ -8,3 +8,4 @@ vsc-extension-quickstart.md
 **/*.map
 **/*.ts
 **/.vscode-test.*
+README-resources

CHANGELOG.md

@@ -8,12 +8,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
-## [1.0.0] - 2024-11-29
+## [1.1.0] - 2024-11-30
+
+### Added
+- completed the `README.md` file with a short explanation about the extension.
+
+### Changed
+- lowered the minimum supported vscode version to `1.54.0`.
+
+
+## [1.0.1] - 2024-11-29
 
 ### Fixed
 - an error finding the initial webview html was fixed.
 
-## [1.0.0] - 2024-11-30
+
+## [1.0.0] - 2024-11-29
 
 ### Added
 - v1.0 Initial mechanism and functionality implemented.

README.md

@@ -1,6 +1,42 @@
-# FileHarmony README
+# FileHarmony
 
 A simple vscode extension to keep two directories in sync.
 
+> NOTE: you need **vscode v1.54.0** minimum to install and use this extension.
 
-[Will be completed soon...]
+
+## How to Use
+
+Simply install the extension. A folder icon should appear on your primary activity bar:
+
+![File Harmony icon on activity bar](./README-resources/01-Activity-Bar-Icon.jpg)
+
+clicking on this icon (highlighted by the red circle) opens the control panel for File Harmony. There are 5 main elements in this panel:
+
+1. **Source Path**: The address (relative or absolute) to the directory where you would want to **copy files from**.
+2. **Target Path**: The address (relative or absolute) to the directory where you would want to **paste files to**.
+3. **Ignore List**: A list of comma separated directories or files names in the **source path** that need to be ignored.
+4. **Sync Status Toggle Switch**: Selects/shows the current sync status (syncing or not).
+5. **Save Button**: Saves the configuration.
+
+
+### Some Notes About This Plugin
+
+There are some gotchas/notes about this plugin that you need to know before using it:
+
+- The "ignore list" does not support patterns/wildcards, **only exact matches**. This is intentional as at my work place I needed things to be very explicit.
+- Sync status is workspace-bound. This means that if you turn syncing on, it **(all configuration) will persist** even after closing vscode. However, the syncing will only happen while vscode is up and running (duh!).
+- If you leave sync status "on" in a workspace and close vscode, launching vscode again will cause an **immediate directory sync**.
+- Syncing is unilateral, therefor changes in the target path do not trigger a sync operation. All such changes will be overwritten the moment a change occurs in the source path.
+- Clicking on the "Sync Status" toggle switch alone will not activate the extension. Do NOT forget to click save.
+- Using the [Command Palette](https://code.visualstudio.com/api/ux-guidelines/command-palette) in vscode and searching for "File Harmony" you can see two commands: one for toggling sync status on/off and another for showing the current sync status.
+
+
+## Pull Requests and Contribution?
+
+Most probably not. This is a purely utilitarian extension I developed for my work place. I do not care to actively maintain it.
+
+
+## License
+
+This extension is under MIT license.

package.json

@@ -7,9 +7,9 @@
 		"name": "Amir Zouerami",
 		"url": "https://github.com/Amir-Zouerami"
 	},
-	"version": "1.0.1",
+	"version": "1.1.0",
 	"engines": {
-		"vscode": "^1.95.0"
+		"vscode": "^1.54.0"
 	},
 	"categories": [
 		"Other"
@@ -67,7 +67,7 @@
 	"devDependencies": {
 		"@types/mocha": "^10.0.9",
 		"@types/node": "20.x",
-		"@types/vscode": "^1.95.0",
+		"@types/vscode": "^1.54.0",
 		"@typescript-eslint/eslint-plugin": "^8.10.0",
 		"@typescript-eslint/parser": "^8.7.0",
 		"@vscode/test-cli": "^0.0.10",