@coralogix/rum-cli 1.1.3 → 1.1.5

package/README.md

@@ -6,8 +6,9 @@ The Coralogix RUM CLI is a command-line interface tool that simplifies the proce
 
 ## Links
 
-- [Coralogix Real User Monitoring](https://coralogix.com/docs/real-user-monitoring/)
+- [Coralogix Real User Monitoring Docs](https://coralogix.com/docs/real-user-monitoring/)
 
+- [Coralogix SDK for Browsers](https://www.npmjs.com/package/@coralogix/browser)
 ## Installation
 
 To install the Coralogix RUM CLI, follow these steps:
@@ -48,6 +49,8 @@ To use the CLI, execute the following command:
 
 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:
+
 1. Create a new file named `upload-source-maps.sh` and open it for editing.
 
 2. Copy and paste the following script into the file, replacing the placeholder values with your actual information:
@@ -62,22 +65,38 @@ APPLICATION="your-application-name"
 ENV="your-environment"
 SOURCE_MAPS_PATH="your-source-maps-path"
 PRIVATE_KEY="your-coralogix-private-key"
+RELEASE_ID="your-release-id"
 
 # Get the commit hash using git rev-parse
 COMMIT_HASH=$(git rev-parse HEAD)
 
-# Calculate short hash for release name
-RELEASE_NAME=${COMMIT_HASH:0:8}
-
 # Run Coralogix RUM CLI to upload source maps
 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"
 ```
 
-If any of the required arguments are missing, the CLI will display an error message and exit.
+<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) |
+| --- |
+
+## 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:
+
+![Upload Source Maps](assets/docs-illustration.png)
+
 # Available Environments
 
 The Coralogix RUM CLI supports the following environments:
@@ -101,7 +120,7 @@ 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.
-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.
+  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.3",
+  "version": "1.1.5",
   "description": "corlogix rum cli",
   "bin": {
     "coralogix-rum-cli": "dist/cli/rum-cli.js"