@coralogix/rum-cli 1.1.6 → 1.1.8

package/README.md

@@ -4,12 +4,12 @@ The Coralogix RUM CLI is a command-line interface tool that simplifies the proce
 
 [![npm version](https://img.shields.io/npm/v/@coralogix/browser.svg)](https://www.npmjs.com/package/@coralogix/browser)
 
-## Links
+# Links
 
 - [Coralogix Real User Monitoring Docs](https://coralogix.com/docs/real-user-monitoring/)
 
 - [Coralogix SDK for Browsers](https://www.npmjs.com/package/@coralogix/browser)
-## Installation
+# Installation
 
 To install the Coralogix RUM CLI, follow these steps:
 
@@ -17,7 +17,7 @@ To install the Coralogix RUM CLI, follow these steps:
 2. Run the following command to install the CLI globally: `npm install -g coralogix-rum-cli`
 3. Once the installation is complete, you can use the CLI by running the `coralogix-rum-cli` command in your terminal.
 
-## Examples
+# Examples
 
 Here are some examples of how to use the Coralogix RUM CLI:
 
@@ -29,9 +29,9 @@ Here are some examples of how to use the Coralogix RUM CLI:
 
 - `coralogix-rum-cli upload-source-maps --help`
 
-## Uplaod source maps
+# Upload source maps
 
-To uplaod source maps support the following options:
+### Options:
 
 - `-k, --private-key <privateKey>`: Private key to authenticate with the Coralogix API.
 - `-a, --application <application>`: Name of the application.
@@ -43,13 +43,9 @@ To uplaod source maps support the following options:
 - `-o, --org-name <orgName>`: GitHub organization name (optional).
 - `-h, --help`: Display help.
 
-To use the CLI, execute the following command:
 
-## Uploading Source Maps Using a Script
 
-To simplify the process of uploading source maps using the Coralogix RUM CLI, you can create a bash script that automates the task. Follow these steps to set up the script:
-
-## For CI Integration:
+### For CI Integration:
 
 1. Create a new file named `upload-source-maps.sh` and open it for editing.
 
@@ -74,6 +70,12 @@ COMMIT_HASH=$(git rev-parse HEAD)
 coralogix-rum-cli upload-source-maps -k "$PRIVATE_KEY" -a "$APPLICATION" -r "$RELEASE_NAME" -f "$SOURCE_MAPS_PATH" -e "$ENV" -c "$COMMIT_HASH" -n "$REPO_NAME" -o "$ORG_NAME"
 ```
 
+### For Non-CI Integration:
+1. Open a terminal window,and run the following command:
+```bash
+coralogix-rum-cli upload-source-maps -k "$PRIVATE_KEY" -a "$APPLICATION" -r "$RELEASE_NAME" -f "$SOURCE_MAPS_PATH" -e "$ENV" -c "$COMMIT_HASH" -n "$REPO_NAME" -o "$ORG_NAME"
+```
+
 <br>
 
 | IMPORTANT: The $RELEASE_ID must align with the content of the version field in your CoralogixRum.init() configuration in [Coralogix SDK for Browsers](https://www.npmjs.com/package/@coralogix/browser) |
@@ -81,25 +83,7 @@ coralogix-rum-cli upload-source-maps -k "$PRIVATE_KEY" -a "$APPLICATION" -r "$RE
 
 <br>
 
-## For Non-CI Integration:
-1. Create a new file named upload-source-maps.sh and open it for editing.
-
-2. Copy and paste the script provided above, and replace the placeholder values with your actual information.
-
-3. Open a terminal window, navigate to the directory containing the upload-source-maps.sh script, and execute the script using the command:
-
-If any of the required arguments are missing, the CLI will display an error message and exit.
-
-Please ensure you provide valid values for the options when using the CLI.
-
-By following these instructions, you can effortlessly upload source maps using the Coralogix RUM CLI script in both CI and non-CI environments.
-
-# Illustration
-Here's an overview of the process, showing the parsed stacktrace in the source map:
-
-<img src="assets/docs-illustration.png"  alt="Upload Source Maps"/>
-
-# Available Environments
+## Available Environments
 
 The Coralogix RUM CLI supports the following environments:
 
@@ -122,6 +106,8 @@ The following options are optional and relate to GitHub information, providing c
 
 
 - `-o, --org-name <orgName>`: This option enables you to input your GitHub organization user, helping to attribute the source maps to the appropriate organization user.
+
+<br>
   Providing these GitHub-related options can enhance the accuracy of source map management and issue tracking within Coralogix RUM. However, they are not mandatory and can be omitted if not applicable.
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coralogix/rum-cli",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "corlogix rum cli",
   "bin": {
     "coralogix-rum-cli": "dist/cli/rum-cli.js"