diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..38beaca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## Version 1.0.0 + +This is the first official release of the project. diff --git a/README.md b/README.md index a47c429..82eea0e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,40 @@ ![Status](https://img.shields.io/badge/status-under%20development-informational?style=for-the-badge) ![Build Status](https://img.shields.io/github/actions/workflow/status/signalfx/splunk-rum-cli/.github/workflows/ci.yml?branch=main&style=for-the-badge) ![GDI Specification](https://img.shields.io/badge/GDI-1.7.0-blueviolet?style=for-the-badge) +![NPM](https://img.shields.io/npm/v/@splunk/rum-cli?style=for-the-badge) ![Node](https://img.shields.io/node/v/@splunk/rum-cli?style=for-the-badge) -* This tool is still under development, so the readme and source code are not yet complete - # Splunk RUM CLI -The Splunk RUM CLI helps developers upload Android mapping files, iOS dSYM files, and browser source map files to the Splunk Observability Cloud backend for deobfuscating stack traces. This tool is part of Splunk's Real User Monitoring (RUM) suite. +The Splunk RUM CLI is a tool for uploading Android mapping files, iOS dSYM files, and browser source map files to the Splunk Observability Cloud back end for deobfuscating or symbolicating stack traces. This tool is part of the Splunk Real User Monitoring (RUM) suite. ## Features * Uploading and listing of Android Proguard mapping files -* Uploading and listing of iOS DSym mapping files +* Uploading and listing of iOS dSYM mapping files * Performing JavaScript bundle modifications to enable automatic source mapping * Uploading JavaScript source map files ## Documentation -For official documentation on the Splunk RUM CLI, see _______ +For official documentation on the Splunk RUM CLI, see +[Install the splunk-rum CLI](https://quickdraw.splunk.com/redirect/?product=Observability&location=rum.buildintegration&version=current) ## Getting Started +To install the CLI from npm, run: +``` +npm install -g @splunk/rum-cli +``` + +After installing, for an overview of the splunk-rum CLI and available commands, run: +``` +splunk-rum +``` + ## Build and Development -To build locally, run the following commands: +To build locally, run: ``` npm install @@ -42,8 +52,6 @@ To develop locally, you can use the `build:watch` script to automatically rebuil npm run build:watch ``` -## Troubleshooting - # License The Splunk RUM CLI is licensed under the terms of the Apache Software License diff --git a/package.json b/package.json index 57dffa7..bed26a6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@splunk/rum-cli", - "version": "0.0.1-alpha.4", + "version": "1.0.0", "description": "Tools for handling symbol and mapping files for symbolication", "main": "./dist/index.js", "files": [