Skip to content

Commit 2153bb0

Browse files
authored
Prepare general release (#142)
* bump version, add changelog * readme changes * remove doc section of readme for now * remove v from tag * update readme * adjust spacing * change dsym spelling * update formatting * changed command wording * update markdown link * remove troubleshooting * update dsym spelling * update run text * change wording * change spelling * add node badge * update wording
1 parent bb1780d commit 2153bb0

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## Version 1.0.0
6+
7+
This is the first official release of the project.

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,40 @@
11
![Status](https://img.shields.io/badge/status-under%20development-informational?style=for-the-badge)
22
![Build Status](https://img.shields.io/github/actions/workflow/status/signalfx/splunk-rum-cli/.github/workflows/ci.yml?branch=main&style=for-the-badge)
33
![GDI Specification](https://img.shields.io/badge/GDI-1.7.0-blueviolet?style=for-the-badge)
4+
![NPM](https://img.shields.io/npm/v/@splunk/rum-cli?style=for-the-badge)
45
![Node](https://img.shields.io/node/v/@splunk/rum-cli?style=for-the-badge)
56

6-
* This tool is still under development, so the readme and source code are not yet complete
7-
87
# Splunk RUM CLI
98

10-
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.
9+
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.
1110

1211
## Features
1312

1413
* Uploading and listing of Android Proguard mapping files
15-
* Uploading and listing of iOS DSym mapping files
14+
* Uploading and listing of iOS dSYM mapping files
1615
* Performing JavaScript bundle modifications to enable automatic source mapping
1716
* Uploading JavaScript source map files
1817

1918
## Documentation
2019

21-
For official documentation on the Splunk RUM CLI, see _______
20+
For official documentation on the Splunk RUM CLI, see
21+
[Install the splunk-rum CLI](https://quickdraw.splunk.com/redirect/?product=Observability&location=rum.buildintegration&version=current)
2222

2323
## Getting Started
2424

25+
To install the CLI from npm, run:
26+
```
27+
npm install -g @splunk/rum-cli
28+
```
29+
30+
After installing, for an overview of the splunk-rum CLI and available commands, run:
31+
```
32+
splunk-rum
33+
```
34+
2535
## Build and Development
2636

27-
To build locally, run the following commands:
37+
To build locally, run:
2838

2939
```
3040
npm install
@@ -42,8 +52,6 @@ To develop locally, you can use the `build:watch` script to automatically rebuil
4252
npm run build:watch
4353
```
4454

45-
## Troubleshooting
46-
4755
# License
4856

4957
The Splunk RUM CLI is licensed under the terms of the Apache Software License

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@splunk/rum-cli",
3-
"version": "0.0.1-alpha.4",
3+
"version": "1.0.0",
44
"description": "Tools for handling symbol and mapping files for symbolication",
55
"main": "./dist/index.js",
66
"files": [

0 commit comments

Comments
 (0)