From d9b5458c5d34bd0925fbe75b6b11b958f79e2649 Mon Sep 17 00:00:00 2001
From: rajeev <jharajeev55@gmail.com>
Date: Mon, 6 May 2024 17:32:26 +0530
Subject: [PATCH] Updating readme file, removing unused workflows

---
 .github/workflows/pr.yml                |  4 +--
 .github/workflows/release.yml           | 34 ---------------------
 .github/workflows/release_candidate.yml | 39 -------------------------
 README.md                               | 11 +++----
 4 files changed, 8 insertions(+), 80 deletions(-)
 delete mode 100644 .github/workflows/release.yml
 delete mode 100644 .github/workflows/release_candidate.yml

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
index d35a294..12b8518 100644
--- a/.github/workflows/pr.yml
+++ b/.github/workflows/pr.yml
@@ -1,4 +1,4 @@
-name: Generate JSON and Save as Artifacts
+name: Parser WebHelp and output npm package contains lua definitions file
 
 on:
   pull_request:
@@ -185,7 +185,7 @@ jobs:
         uses: ncipollo/release-action@v1
         with:
           name: ${{steps.lasttag.outputs.version}}
-          artifacts: "extension/*.vsix,sbom/**/*"
+          artifacts: "keithley_instrument_libraries,generated-json"
           body: |
             ## Features Requests / Bugs
 
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
deleted file mode 100644
index 5acab2d..0000000
--- a/.github/workflows/release.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-name: Create Release
-
-# Create a release tag automatically when a pull request from a `release/**` branch is
-# merged into the `main` branch.
-# This will create the tag which will kick off a new build with a tagged release.
-
-on:
-  pull_request:
-    branches:
-      - "release/**"
-    types:
-      - closed
-
-jobs:
-  tag:
-    name: Tag Release
-    runs-on: ubuntu-latest
-    if: github.event.pull_request.merged == true && github.base_ref == 'main'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          set-safe-directory: "*"
-      - name: Get Version
-        id: version
-        run: |
-          V="${GITHUB_REF#refs/heads/release/v}"
-          echo "version=${V}" >> $GITHUB_OUTPUT
-      - name: Create Tag
-        run: |
-          V="v${{steps.version.outputs.version}}"
-
-          git tag "$V" -m "Release $V"
-          git push "$V"
diff --git a/.github/workflows/release_candidate.yml b/.github/workflows/release_candidate.yml
deleted file mode 100644
index 3627a45..0000000
--- a/.github/workflows/release_candidate.yml
+++ /dev/null
@@ -1,39 +0,0 @@
-name: Release Candidate
-
-# Create a release candidate tag automatically when a pull request from a `release/**`
-# branch is merged into the `main` branch.
-# This will create the tag which will kick off a new build with a tagged release
-# candidate.
-
-on:
-  pull_request:
-    branches:
-      - "release/**"
-
-jobs:
-  tag:
-    name: Tag Release Candidate
-    runs-on: ubuntu-latest
-    if: github.base_ref == 'main'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          set-safe-directory: "*"
-      - name: Get Version
-        id: version
-        run: |
-          V="${GITHUB_REF#refs/heads/release/v}"
-          echo "version=${V}" >> $GITHUB_OUTPUT
-      - name: Create Tag
-        run: |
-          V="v${{steps.version.outputs.version}}"
-          LATEST="${V}-0" # Default to RC 0
-          NUM_RCS=$(git tag --list "${V}-*" | wc -l)
-
-          if [[ $NUM_RCS -gt 0 ]]; then
-            LATEST="${V}-$((NUM_RCS))"
-          fi
-
-          git tag "$LATEST" -m "Release Candidate $LATEST"
-          git push "$LATEST"
diff --git a/README.md b/README.md
index f2abf20..bdf83c6 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
 # tsp-toolkit-webhelp-to-json
-The parser to convert from the WebHelp version of the instrument command-set references to the internal JSON format.
+This repository contains tools for converting Keithley instruments WebHelp documents into Lua definitions files. The conversion process occurs in two steps:
 
+## 1. WebHelp to Internal JSON:
+In this initial step, the tool takes a Keithley instruments WebHelp documents and converts it into an internal JSON format.
+
+## 2. Internal JSON to Lua Definitions: 
+Once the WebHelp document is converted into internal JSON, the tool proceeds to generate Lua definitions files. These Lua files are packaged into an npm package.
 
-# Quick Start
-- Clone the repo
-- Go to **Configuration.py** file and update the configurations
-- Open **main.py** file and start run