Skip to content

Commit 7a1a053

Browse files
committed
docs: add logos & banner to docs
1 parent 2bd9f2b commit 7a1a053

File tree

8 files changed

+29
-12
lines changed

8 files changed

+29
-12
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,26 @@
1-
# React Native Ottrelite
1+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=ottrelite" align="center">
2+
<picture>
3+
<img alt="Ottrelite" src="https://github.com/callstackincubator/ottrelite/blob/main/img/banner.jpg?raw=true">
4+
</picture>
5+
</a>
26

3-
- [React Native Ottrelite](#react-native-ottrelite)
4-
- [State of the project](#state-of-the-project)
5-
- [Development API](#development-api)
6-
- [OTEL Interoperability](#otel-interoperability)
7-
- [RN internals integration](#rn-internals-integration)
8-
- [Installation](#installation)
9-
- [Documentation](#documentation)
7+
<p align="center">
8+
<b>Ottrelite</b> - Unified, extensible, cross-language tracing toolkit for React Native ⚡️🔎
9+
</p>
1010

1111
---
1212

13+
[![Build packages, lint & run tests](https://github.com/callstackincubator/ottrelite/actions/workflows/ci-cd.yml/badge.svg?job=build-lint-test)](https://github.com/callstackincubator/ottrelite/actions/workflows/ci-cd.yml)
14+
[![npm downloads](https://img.shields.io/npm/dm/ottrelite.svg)](https://www.npmjs.com/package/ottrelite)
15+
16+
17+
- [State of the project](#state-of-the-project)
18+
- [Development API](#development-api)
19+
- [OTEL Interoperability](#otel-interoperability)
20+
- [RN internals integration](#rn-internals-integration)
21+
- [Installation](#installation)
22+
- [Documentation](#documentation)
23+
1324
The aim of this project is to provide a unified API for performance tracing in React Native applications, allowing developers to easily instrument their apps with various backends for tracing, profiling, and performance monitoring.
1425

1526
The core package - `@ottrelite/core` - provides a so-called [**Development API**](#development-api) (which is designed to be consumed by programmers) for instrumenting your application for purely **development use cases** (profiling your code, tracing performance issues, etc.). The actual implementation of recording / displaying / reporting of the data is provided by individual, pluggable packages (called **backends**). An arbitrary number of backends (0, 1 or more) can be installed simultaneously, allowing you to use multiple backends at once, or switch between them as needed.

docs/docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ hero:
1515
text: GitHub
1616
link: https://github.com/web-infra-dev/rspress
1717
image:
18-
src: /logo.png
19-
alt: Ottrelite Logo
18+
src:
19+
light: /img/logo-light.png
20+
dark: /img/logo-dark.png
21+
alt: Ottrelite logo
2022
features:
2123
- title: Unified API
2224
details: All functionalities are accessible through a single API, regardless of the backend used. If a backend does not support a specific feature, it will simply be ignored by calls to that feature.

docs/docs/public/img/favicon.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/docs/public/img/logo-dark.png

3.34 KB
Loading
3.28 KB
Loading

docs/docs/public/img/logo.png

-601 Bytes
Binary file not shown.

docs/rspress.config.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ export default defineConfig({
1010
title: 'React Native Ottrelite',
1111
description: 'React Native Ottrelite Documentation',
1212
logoText: 'React Native Ottrelite',
13-
icon: '/img/logo.png',
14-
logo: '/img/logo.png',
13+
icon: '/img/favicon.svg',
14+
logoDark: '/img/logo-dark.png',
15+
logoLight: '/img/logo-light.png',
1516
themeConfig: {
1617
socialLinks: [
1718
{

img/banner.jpg

577 KB
Loading

0 commit comments

Comments
 (0)