Skip to content

Commit 83db163

Browse files
Dvernon/MOB-3251 Update Readme (#153)
* MOB-3251 updating README with badges and links * Update README.md Update readme with troubleshooting section * Update README.md with build badge and troubleshooting link * Update README.md Otel version
1 parent 61e31d3 commit 83db163

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
---
2+
3+
<p align="center">
4+
<strong>
5+
<a href="CONTRIBUTING.md">Getting Involved</a>
6+
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
7+
<a href="SECURITY.md">Security</a>
8+
</strong>
9+
</p>
10+
11+
<p align="center">
12+
<img alt="Stable" src="https://img.shields.io/badge/status-stable-informational?style=for-the-badge">
13+
<a href="https://github.com/open-telemetry/opentelemetry-swift/releases/tag/1.5.0">
14+
<img alt="OpenTelemetry Swift" src="https://img.shields.io/badge/otel-1.5.0-blueviolet?style=for-the-badge">
15+
</a>
16+
<a href="https://github.com/signalfx/gdi-specification/releases/tag/v1.5.0">
17+
<img alt="Splunk GDI specification" src="https://img.shields.io/badge/GDI-1.5.0-blueviolet?style=for-the-badge">
18+
</a>
19+
<a href="https://github.com/signalfx/splunk-otel-ios/releases">
20+
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/signalfx/splunk-otel-ios?include_prereleases&style=for-the-badge">
21+
</a>
22+
<a href="https://github.com/signalfx/splunk-otel-ios/actions/workflows/ci.yml">
23+
<img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/signalfx/splunk-otel-ios/.github/workflows/ci.yml?branch=main&style=for-the-badge">
24+
</a>
25+
</p>
26+
27+
---
128

229
# Splunk RUM agent for iOS
330

@@ -32,6 +59,10 @@ You can manually instrument iOS applications for Splunk RUM using the iOS RUM ag
3259

3360
See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on building, running tests, and so on.
3461

62+
## Troubleshooting
63+
64+
For troubleshooting issues with the Splunk OpenTelemetry iOS instrumentation, see [Troubleshoot iOS instrumentation for Splunk Observability Cloud](https://docs.splunk.com/Observability/gdi/get-data-in/rum/ios/troubleshooting.html) in the official documentation.
65+
3566
## License
3667

3768
This library is licensed under the terms of the Apache Softare License version 2.0.

0 commit comments

Comments
 (0)