Skip to content

Dvernon/MOB-3251 Update Readme #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 1, 2023
Merged

Dvernon/MOB-3251 Update Readme #153

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97f8385
MOB-3251 updating README with badges and links
dvernon-splunk Jul 18, 2023
b70d812
Update README.md
dvernon-splunk Jul 20, 2023
d6ac1bd
Update README.md with build badge and troubleshooting link
dvernon-splunk Jul 25, 2023
bc4a645
Update README.md Otel version
dvernon-splunk Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
---

<p align="center">
<strong>
<a href="CONTRIBUTING.md">Getting Involved</a>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="SECURITY.md">Security</a>
</strong>
</p>

<p align="center">
<img alt="Stable" src="https://img.shields.io/badge/status-stable-informational?style=for-the-badge">
<a href="https://github.com/open-telemetry/opentelemetry-swift/releases/tag/1.5.0">
<img alt="OpenTelemetry Swift" src="https://img.shields.io/badge/otel-1.5.0-blueviolet?style=for-the-badge">
</a>
<a href="https://github.com/signalfx/gdi-specification/releases/tag/v1.5.0">
<img alt="Splunk GDI specification" src="https://img.shields.io/badge/GDI-1.5.0-blueviolet?style=for-the-badge">
</a>
<a href="https://github.com/signalfx/splunk-otel-ios/releases">
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/signalfx/splunk-otel-ios?include_prereleases&style=for-the-badge">
</a>
<a href="https://github.com/signalfx/splunk-otel-ios/actions/workflows/ci.yml">
<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">
</a>
</p>

---

# Splunk RUM agent for iOS

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

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

## Troubleshooting

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.

## License

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