From e6a3ae461ab0e179a515775e26ab4e89a994c535 Mon Sep 17 00:00:00 2001
From: yaad96 <yaadmainul@gmail.com>
Date: Wed, 27 Mar 2024 19:43:16 -0400
Subject: [PATCH] changed the name of the extension, updated README and
 packaged the extension as " activedoc-0.0.1.vsix"

---
 README.md         | 35 ++++++++++++++++++++++++++---------
 package-lock.json |  4 ++--
 package.json      | 15 +++++++--------
 src/extension.ts  |  4 ++--
 4 files changed, 37 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 1a28041..ae037e6 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,30 @@
-# first-extension README
+# activeDoc Extension for VSCode
 
-This is the README for your extension "first-extension". After writing up a brief description, we recommend including the following sections.
+This is the README for the "activeDoc" extension for VSCode.
 
-# VSCode Extension doesn't have recentSearchedKeywords array
+## version 0.0.1.vsix state 
+- The search keywords of a vscode workspace is not accessible to the VSCode API users. So, `searchedElements` property is not present in the vscode extension
+- In mac, clicking on a code snippet on the client (web) app is not redirecting the vscode workspace focused file's intended code snippet as it should.
 
-# running the extension
-after cloning the repo, open terminal and run "npm install"
-then in the vscode, you can press F5 to run the extension, or there should be a button in the left side of the vscode that looks like
-a beetle under the play icon called "Run and Debug".
-Clicking on it you should see green play icon.
-After that you can refresh the client.
+## Features
+
+- Describe the key features.
+- Explain how these features improve the user experience or development process.
+
+## Installation
+
+### Running the Extension Codebase
+
+1. After cloning the repo, open a terminal in the project directory.
+2. Run `npm install` to install the necessary dependencies.
+3. To run the extension in a development environment, press `F5` in VSCode, or click on the "Run and Debug" icon (resembles a beetle under the play icon) on the left sidebar. Then, click on the green play icon to start.
+
+### Installing the Packaged Extension
+
+To install the `.vsix` packaged extension:
+
+1. Open VS Code.
+2. Go to the Extensions view by clicking on the square icon on the sidebar or pressing `Ctrl+Shift+X`.
+3. Click on the "..." menu at the top of the Extensions view and select "Install from VSIX...".
+4. Navigate to the `.vsix` file, select it, and click "Open".
 
diff --git a/package-lock.json b/package-lock.json
index f95e764..16aa8b4 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,11 +1,11 @@
 {
-  "name": "first-extension",
+  "name": "activedoc",
   "version": "0.0.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
-      "name": "first-extension",
+      "name": "activedoc",
       "version": "0.0.1",
       "dependencies": {
         "ws": "^8.16.0"
diff --git a/package.json b/package.json
index 82567bb..1a3076d 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "first-extension",
-  "displayName": "first_extension",
+  "name": "activedoc",
+  "displayName": "ActiveDoc",
   "description": "testing",
   "version": "0.0.1",
   "engines": {
@@ -11,17 +11,16 @@
   ],
   "activationEvents": [
     "onStartupFinished"
-]
-,
+  ],
   "main": "./out/extension.js",
   "contributes": {
     "commands": [
       {
-        "command": "first-extension.helloWorld",
+        "command": "activedoc.helloWorld",
         "title": "Hello World"
       },
       {
-        "command": "extension.mineRules",
+        "command": "activedoc.mineRules",
         "title": "Mine Rules"
       }
     ],
@@ -29,7 +28,7 @@
       "editor/context": [
         {
           "when": "editorTextFocus",
-          "command": "extension.mineRules",
+          "command": "activedoc.mineRules",
           "group": "navigation"
         }
       ]
@@ -58,4 +57,4 @@
   "dependencies": {
     "ws": "^8.16.0"
   }
-}
\ No newline at end of file
+}
diff --git a/src/extension.ts b/src/extension.ts
index efe0672..0676886 100644
--- a/src/extension.ts
+++ b/src/extension.ts
@@ -116,7 +116,7 @@ export function activate(context: vscode.ExtensionContext) {
 
 
                     // Adding "Mine Rules" command functionality
-                    context.subscriptions.push(vscode.commands.registerCommand('extension.mineRules', () => {
+                    context.subscriptions.push(vscode.commands.registerCommand('activedoc.mineRules', () => {
                         const editor = vscode.window.activeTextEditor;
                         if (editor) {
                             const document = editor.document;
@@ -216,7 +216,7 @@ export function activate(context: vscode.ExtensionContext) {
 
 
 
-    context.subscriptions.push(vscode.commands.registerCommand('first-extension.helloWorld', () => {
+    context.subscriptions.push(vscode.commands.registerCommand('activedoc.helloWorld', () => {
         vscode.window.showInformationMessage('Hello World from ActiveDocumentation!');
     }));