Skip to content

Commit e9e591b

Browse files
committed
docs: updated READMEs
1 parent df3ec7b commit e9e591b

File tree

6 files changed

+129
-9
lines changed

6 files changed

+129
-9
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,25 @@
44
</picture>
55
</a>
66

7-
<p align="center">
7+
<h3 align="center">
88
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
9-
</p>
9+
</h3>
1010

1111
---
1212

13-
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
14-
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
15-
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
16-
[![npm downloads](https://img.shields.io/npm/dm/ottrelite.svg)](https://www.npmjs.com/package/ottrelite)
13+
<div align="center">
1714

15+
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
16+
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
17+
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
18+
19+
[![core npm downloads](https://img.shields.io/npm/dm/@ottrelite/core.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Fcore)](https://www.npmjs.com/package/@ottrelite/core)
20+
[![instrumentation-react npm downloads](https://img.shields.io/npm/dm/@ottrelite/instrumentation-react.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Finstrumentation-react)](https://www.npmjs.com/package/@ottrelite/instrumentation-react)
21+
[![backend-platform npm downloads](https://img.shields.io/npm/dm/@ottrelite/backend-platform.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Fbackend-platform)](https://www.npmjs.com/package/@ottrelite/backend-platform)
22+
[![backend-wrapper-tracy npm downloads](https://img.shields.io/npm/dm/@ottrelite/backend-wrapper-tracy.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Fbackend-wrapper-tracy)](https://www.npmjs.com/package/@ottrelite/backend-wrapper-tracy)
23+
[![interop-otel npm downloads](https://img.shields.io/npm/dm/@ottrelite/interop-otel.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Finterop-otel)](https://www.npmjs.com/package/@ottrelite/interop-otel)
24+
25+
</div>
1826

1927
- [State of the project](#state-of-the-project)
2028
- [Development API](#development-api)

packages/backend-platform/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
22

33
This plugin is the platform-specific backend implementation for RN Ottrelite Core. On Android, it utilizes [ATrace](https://developer.android.com/ndk/reference/group/tracing) (Android tracing API), on iOS it utilizes the [OSSignposter API](https://developer.apple.com/documentation/os/ossignposter).
44

5+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=ottrelite" align="center">
6+
<picture>
7+
<img alt="Ottrelite" src="https://github.com/callstackincubator/ottrelite/blob/main/img/banner.jpg?raw=true">
8+
</picture>
9+
</a>
10+
11+
<h3 align="center">
12+
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
13+
</h3>
14+
15+
---
16+
17+
<div align="center">
18+
19+
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
20+
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
21+
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
22+
23+
[![backend-platform npm downloads](https://img.shields.io/npm/dm/@ottrelite/backend-platform.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Fbackend-platform)](https://www.npmjs.com/package/@ottrelite/backend-platform)
24+
25+
</div>
26+
527
## Supported features
628

729
| Feature | Support level |

packages/backend-wrapper-tracy/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
22

33
This plugin is a wrapper around the [open-source Tracy profiler](https://github.com/wolfpld/tracy) client, which brings tracing using Tracy to Ottrelite.
44

5+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=ottrelite" align="center">
6+
<picture>
7+
<img alt="Ottrelite" src="https://github.com/callstackincubator/ottrelite/blob/main/img/banner.jpg?raw=true">
8+
</picture>
9+
</a>
10+
11+
<h3 align="center">
12+
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
13+
</h3>
14+
15+
---
16+
17+
<div align="center">
18+
19+
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
20+
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
21+
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
22+
23+
[![backend-wrapper-tracy npm downloads](https://img.shields.io/npm/dm/@ottrelite/backend-wrapper-tracy.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Fbackend-wrapper-tracy)](https://www.npmjs.com/package/@ottrelite/backend-wrapper-tracy)
24+
25+
</div>
26+
527
## Supported features
628

729
| Feature | Support level |

packages/core/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
22

33
This is the core package of the Ottrelite library for React Native, which provides a unified interface for various backends that can be used to trace and profile React Native applications.
44

5+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=ottrelite" align="center">
6+
<picture>
7+
<img alt="Ottrelite" src="https://github.com/callstackincubator/ottrelite/blob/main/img/banner.jpg?raw=true">
8+
</picture>
9+
</a>
10+
11+
<h3 align="center">
12+
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
13+
</h3>
14+
15+
---
16+
17+
<div align="center">
18+
19+
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
20+
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
21+
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
22+
23+
[![core npm downloads](https://img.shields.io/npm/dm/@ottrelite/core.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Fcore)](https://www.npmjs.com/package/@ottrelite/core)
24+
25+
</div>
26+
527
## Documentation
628

729
All the features, usage & installation of this package and extending it are documented in the [documentation](https://callstackincubator.github.io/ottrelite/docs/core/quick-start.html).
Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1-
# Ottrelite Instrumentation for React Babel Plugin
1+
# @ottrelite/instrumentation-react
22

3-
Please read the [documentation website](https://callstackincubator.github.io/ottrelite/docs/instrumentation-react/quick-start.html).
3+
This plugin provides ways to automatically instrument React components with Ottrelite traces, using a Babel plugin.
4+
5+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=ottrelite" align="center">
6+
<picture>
7+
<img alt="Ottrelite" src="https://github.com/callstackincubator/ottrelite/blob/main/img/banner.jpg?raw=true">
8+
</picture>
9+
</a>
10+
11+
<h3 align="center">
12+
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
13+
</h3>
14+
15+
---
16+
17+
<div align="center">
18+
19+
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
20+
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
21+
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
22+
23+
[![instrumentation-react npm downloads](https://img.shields.io/npm/dm/@ottrelite/instrumentation-react.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Finstrumentation-react)](https://www.npmjs.com/package/@ottrelite/instrumentation-react)
24+
25+
</div>
26+
27+
Please read the [documentation website](https://callstackincubator.github.io/ottrelite/docs/instrumentation-react/quick-start.html) for more details.

packages/interop-otel/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
# @ottrelite/interop-otel
22

3-
This provides an interoperability layer between Ottrelite and OTEL SDKs. To avoid confusion, this project is not affiliated and not part of OpenTelemetry.
3+
This package provides an interoperability layer between Ottrelite and OTEL SDKs. To avoid confusion, this project is not affiliated and not part of OpenTelemetry.
4+
5+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=ottrelite" align="center">
6+
<picture>
7+
<img alt="Ottrelite" src="https://github.com/callstackincubator/ottrelite/blob/main/img/banner.jpg?raw=true">
8+
</picture>
9+
</a>
10+
11+
<h3 align="center">
12+
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
13+
</h3>
14+
15+
---
16+
17+
<div align="center">
18+
19+
[![Release](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/release.yml)
20+
[![Docs](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/docs.yml)
21+
[![Build, lint & test (JS)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml/badge.svg)](https://github.com/callstackincubator/ottrelite/actions/workflows/build-lint-test.yml)
22+
23+
[![interop-otel npm downloads](https://img.shields.io/npm/dm/@ottrelite/interop-otel.svg?style=flat-square&label=NPM%20-%20%40ottrelite%2Finterop-otel)](https://www.npmjs.com/package/@ottrelite/interop-otel)
24+
25+
</div>
426

527
## Documentation
628

0 commit comments

Comments
 (0)