Skip to content

Commit 956ecae

Browse files
mkopcinsmsluszniak
mkopcins
and
msluszniak
authored
Chore: Add minor improvements to README.md (#656)
## Description Add minor improvements to `README.md`: - Add additional badges (stars, documentation, and contributors) - Center badges and library name at the top of the readme - Change link from GH of Private Mind to landing page - Add accordion on Table of Content - Fix spelling of ExecuTorch in one place - Add consistent title case for all sub-headings - Move documentation section (Right now, there is also badge with documentation, so section about documentation doesn't need to be at the top of README.md anymore) If every change is ok, analogical changes need to be done in different languages ### Introduces a breaking change? - [ ] Yes - [x] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [x] Documentation update (improves or adds clarity to existing documentation) - [ ] Other (chores, tests, code style improvements etc.) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions <!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. --> ### Screenshots <!-- Add screenshots here, if applicable --> ### Related issues <!-- Link related issues here using #issue-number --> ### Checklist - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] I have updated the documentation accordingly - [ ] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. --> --------- Co-authored-by: Mateusz Sluszniak <[email protected]> Co-authored-by: Mateusz Słuszniak <[email protected]>
1 parent 374afef commit 956ecae

File tree

6 files changed

+177
-155
lines changed

6 files changed

+177
-155
lines changed

‎README.md‎

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
<div align="right">
2-
<h1 align="left" style="display:inline-block">React Native ExecuTorch
3-
<!-- Discord Badge -->
4-
<a href="https://discord.gg/ZGqqY55qkP">
5-
<img src="https://img.shields.io/badge/Discord-Join%20Us-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community">
6-
</a>
1+
<div align="center">
2+
<h1 align="center" style="display:inline-block">React Native ExecuTorch
73
</h1>
84
</div>
95

6+
<div align="center">
7+
<a href="https://github.com/software-mansion/react-native-executorch/graphs/contributors"><img src="https://img.shields.io/github/contributors/software-mansion/react-native-executorch?style=for-the-badge&color=00008B" alt="GitHub - Contributors"></a>
8+
<a href="https://github.com/software-mansion/react-native-executorch/stargazers"><img src="https://img.shields.io/github/stars/software-mansion/react-native-executorch?style=for-the-badge&color=00008B" alt="GitHub - Stars"></a>
9+
<a href="https://discord.gg/ZGqqY55qkP"><img src="https://img.shields.io/badge/Discord-Join%20Us-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community"></a>
10+
<a href="https://docs.swmansion.com/react-native-executorch/"><img src="https://img.shields.io/badge/Documentation-00008B?logo=googledocs&logoColor=white&style=for-the-badge" alt="Documentation"></a>
11+
</div>
12+
1013
![Software Mansion banner](https://github.com/user-attachments/assets/fa2c4735-e75c-4cc1-970d-88905d95e3a4)
1114

1215
<p align="center">
@@ -27,35 +30,33 @@ React Native ExecuTorch bridges the gap between React Native and native platform
2730
[![npm version](https://img.shields.io/npm/v/react-native-executorch?color=00008B)](https://www.npmjs.com/package/react-native-executorch)
2831
[![CI](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml/badge.svg)](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml)
2932

30-
**Table of contents:**
33+
<details>
34+
<summary><strong> :blue_book: Table of Contents </strong></summary>
3135

32-
- [:yin_yang: Supported versions](#yin_yang-supported-versions)
33-
- [:books: Documentation](#books-documentation)
34-
- [:earth_africa: Real-World Example](#earth_africa-real-world-example)
36+
- [:yin_yang: Supported Versions](#yin_yang-supported-versions)
37+
- [:earth_africa: Real-world Example](#earth_africa-real-world-example)
3538
- [:llama: Quickstart - Running Llama](#llama-quickstart---running-llama)
36-
- [:calling: Demo apps](#calling-demo-apps)
37-
- [:robot: Ready-made models](#robot-ready-made-models)
39+
- [:calling: Demo Apps](#calling-demo-apps)
40+
- [:robot: Ready-made Models](#robot-ready-made-models)
41+
- [:books: Documentation](#books-documentation)
3842
- [:balance_scale: License](#balance_scale-license)
39-
- [:soon: What's next?](#soon-whats-next)
43+
- [:soon: What's Next?](#soon-whats-next)
4044

41-
## :yin_yang: Supported versions
45+
</details>
46+
47+
## :yin_yang: Supported Versions
4248

4349
The minimal supported version are:
4450
* iOS 17.0
4551
* Android 13
4652
* React Native 0.76
4753

4854
> [!IMPORTANT]
49-
> React Native Executorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
55+
> React Native ExecuTorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
5056
51-
## :books: Documentation
57+
## :earth_africa: Real-world Example
5258

53-
Check out how our library can help you build your React Native AI features by visiting our docs:
54-
https://docs.swmansion.com/react-native-executorch
55-
56-
## :earth_africa: Real-World Example
57-
58-
React Native ExecuTorch is powering [Private Mind](https://github.com/software-mansion-labs/private-mind), a privacy-first mobile AI app available on [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) and [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
59+
React Native ExecuTorch is powering [Private Mind](https://privatemind.swmansion.com/), a privacy-first mobile AI app available on [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) and [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
5960

6061
<img width="2720" height="1085" alt="Private Mind promo" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
6162

@@ -90,7 +91,7 @@ function MyComponent() {
9091
}
9192
```
9293

93-
### :three: **Run the model!**
94+
### :three: **Run the Model!**
9495

9596
```tsx
9697
const handleGenerate = async () => {
@@ -105,7 +106,7 @@ const handleGenerate = async () => {
105106
};
106107
```
107108

108-
## :calling: Demo apps
109+
## :calling: Demo Apps
109110

110111
We currently host a few example [apps](https://github.com/software-mansion/react-native-executorch/tree/main/apps) demonstrating use cases of our library:
111112

@@ -129,15 +130,20 @@ yarn expo run:< ios | android >
129130
> [!WARNING]
130131
> Running LLMs requires a significant amount of RAM. If you are encountering unexpected app crashes, try to increase the amount of RAM allocated to the emulator.
131132
132-
## :robot: Ready-made models
133+
## :robot: Ready-made Models
133134

134135
Our library has a number of ready-to-use AI models; a complete list is available in the documentation. If you're interested in running your own AI model, you need to first export it to the `.pte` format. Instructions on how to do this are available in the [Python API](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) and [optimum-executorch README](https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately).
135136

137+
## :books: Documentation
138+
139+
Check out how our library can help you build your React Native AI features by visiting our docs:
140+
https://docs.swmansion.com/react-native-executorch
141+
136142
## :balance_scale: License
137143

138144
This library is licensed under [The MIT License](./LICENSE).
139145

140-
## :soon: What's next?
146+
## :soon: What's Next?
141147

142148
To learn about our upcoming plans and developments, please visit our [milestones](https://github.com/software-mansion/react-native-executorch/milestones).
143149

‎readmes/README_cn.md‎

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
<div align="right">
2-
<h1 align="left" style="display:inline-block">React Native ExecuTorch
3-
<!-- Discord Badge -->
4-
<a href="https://discord.gg/ZGqqY55qkP">
5-
<img src="https://img.shields.io/badge/Discord-Join%20Us-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community">
6-
</a>
1+
<div align="center">
2+
<h1 align="center" style="display:inline-block">React Native ExecuTorch
73
</h1>
84
</div>
95

6+
<div align="center">
7+
<a href="https://github.com/software-mansion/react-native-executorch/graphs/contributors"><img src="https://img.shields.io/github/contributors/software-mansion/react-native-executorch?style=for-the-badge&color=00008B" alt="GitHub - Contributors"></a>
8+
<a href="https://github.com/software-mansion/react-native-executorch/stargazers"><img src="https://img.shields.io/github/stars/software-mansion/react-native-executorch?style=for-the-badge&color=00008B" alt="GitHub - Stars"></a>
9+
<a href="https://discord.gg/ZGqqY55qkP"><img src="https://img.shields.io/badge/Discord-加入我们-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community"></a>
10+
<a href="https://docs.swmansion.com/react-native-executorch/"><img src="https://img.shields.io/badge/文档-00008B?logo=googledocs&logoColor=white&style=for-the-badge" alt="Documentation"></a>
11+
</div>
12+
1013
![Software Mansion banner](https://github.com/user-attachments/assets/fa2c4735-e75c-4cc1-970d-88905d95e3a4)
1114

1215
<p align="center">
@@ -27,35 +30,34 @@ React Native ExecuTorch 架起了 React Native 和原生平台功能之间的桥
2730
[![npm version](https://img.shields.io/npm/v/react-native-executorch?color=00008B)](https://www.npmjs.com/package/react-native-executorch)
2831
[![CI](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml/badge.svg)](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml)
2932

30-
**目录:**
33+
<details>
34+
<summary><strong> :blue_book: 目录 </strong></summary>
3135

3236
- [:yin_yang: 支持的版本](#yin_yang-supported-versions)
33-
- [:books: 文档](#books-documentation)
3437
- [:earth_africa: 实际案例](#earth_africa-real-world-example)
3538
- [:llama: 快速入门 - 运行 Llama](#llama-quickstart---running-llama)
3639
- [:calling: 示例应用](#calling-demo-apps)
3740
- [:robot: 现成模型](#robot-ready-made-models)
41+
- [:books: 文档](#books-documentation)
3842
- [:balance_scale: 许可证](#balance_scale-license)
3943
- [:soon: 接下来是什么？](#soon-whats-next)
4044

41-
## :yin_yang: 支持的版本
45+
</details>
4246

43-
最低支持版本为：
44-
* iOS 17.0
45-
* Android 13
46-
* React Native 0.76
47+
## :yin_yang: 支持的版本
4748

48-
> [!IMPORTANT]
49-
> React Native Executorch 仅支持 [New React Native architecture](https://reactnative.dev/architecture/landing-page)。
49+
最低支持版本为：
5050

51-
## :books: 文档
51+
- iOS 17.0
52+
- Android 13
53+
- React Native 0.76
5254

53-
查看我们的文档，了解我们的库如何帮助您构建 React Native AI 功能：
54-
https://docs.swmansion.com/react-native-executorch
55+
> [!IMPORTANT]
56+
> React Native ExecuTorch 仅支持 [New React Native architecture](https://reactnative.dev/architecture/landing-page)。
5557
5658
## :earth_africa: 实际案例
5759

58-
React Native ExecuTorch 为 [Private Mind](https://github.com/software-mansion-labs/private-mind) 提供了动力，这是一款以隐私优先的移动 AI 应用程序，可在 [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) 和 [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind) 上获得。
60+
React Native ExecuTorch 为 [Private Mind](https://privatemind.swmansion.com/) 提供了动力，这是一款以隐私优先的移动 AI 应用程序，可在 [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) 和 [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind) 上获得。
5961

6062
<img width="2720" height="1085" alt="Private Mind promo" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
6163

@@ -77,11 +79,7 @@ yarn expo run:< ios | android >
7779
将此添加到您的组件文件中：
7880

7981
```tsx
80-
import {
81-
useLLM,
82-
LLAMA3_2_1B,
83-
Message
84-
} from 'react-native-executorch';
82+
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
8583

8684
function MyComponent() {
8785
// 初始化模型 🚀
@@ -96,7 +94,7 @@ function MyComponent() {
9694
const handleGenerate = async () => {
9795
const chat: Message[] = [
9896
{ role: 'system', content: 'You are a helpful assistant' },
99-
{ role: 'user', content: 'What is the meaning of life?' }
97+
{ role: 'user', content: 'What is the meaning of life?' },
10098
];
10199

102100
// 聊天生成
@@ -133,6 +131,11 @@ yarn expo run:< ios | android >
133131

134132
我们的库中有许多现成可用的 AI 模型；完整列表可在文档中查看。如果您有兴趣运行自己的 AI 模型，首先需要将其导出为 `.pte` 格式。关于如何执行此操作的说明可在 [Python API](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) 和 [optimum-executorch 说明](https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately) 中获取。
135133

134+
## :books: 文档
135+
136+
查看我们的文档，了解我们的库如何帮助您构建 React Native AI 功能：
137+
https://docs.swmansion.com/react-native-executorch
138+
136139
## :balance_scale: 许可证
137140

138141
此库受 [MIT 许可证](./LICENSE) 许可。
@@ -145,4 +148,4 @@ yarn expo run:< ios | android >
145148

146149
自 2012 年以来，[Software Mansion](https://swmansion.com) 是一家拥有构建网络和移动应用经验的软件机构。我们是核心 React Native 贡献者，并且是处理各种 React Native 问题的专家。我们可以帮助您构建下一个梦想产品——[雇佣我们](https://swmansion.com/contact/projects?utm_source=react-native-executorch&utm_medium=readme)。
147150

148-
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-executorch-github 'Software Mansion')](https://swmansion.com)
151+
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-executorch-github 'Software Mansion')](https://swmansion.com)

‎readmes/README_es.md‎

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
<div align="right">
2-
<h1 align="left" style="display:inline-block">React Native ExecuTorch
3-
<!-- Insignia de Discord -->
4-
<a href="https://discord.gg/ZGqqY55qkP">
5-
<img src="https://img.shields.io/badge/Discord-Únete%20a%20Nosotros-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Únete a nuestra comunidad en Discord">
6-
</a>
1+
<div align="center">
2+
<h1 align="center" style="display:inline-block">React Native ExecuTorch
73
</h1>
84
</div>
95

6+
<div align="center">
7+
<a href="https://github.com/software-mansion/react-native-executorch/graphs/contributors"><img src="https://img.shields.io/github/contributors/software-mansion/react-native-executorch?style=for-the-badge&color=00008B" alt="GitHub - Contributors"></a>
8+
<a href="https://github.com/software-mansion/react-native-executorch/stargazers"><img src="https://img.shields.io/github/stars/software-mansion/react-native-executorch?style=for-the-badge&color=00008B" alt="GitHub - Stars"></a>
9+
<a href="https://discord.gg/ZGqqY55qkP"><img src="https://img.shields.io/badge/Únete%20a%20nosotros-00008B?logo=discord&logoColor=white&style=for-the-badge" alt="Join our Discord community"></a>
10+
<a href="https://docs.swmansion.com/react-native-executorch/"><img src="https://img.shields.io/badge/Documentación-00008B?logo=googledocs&logoColor=white&style=for-the-badge" alt="Documentation"></a>
11+
</div>
12+
1013
![Banner de Software Mansion](https://github.com/user-attachments/assets/fa2c4735-e75c-4cc1-970d-88905d95e3a4)
1114

1215
<p align="center">
@@ -27,35 +30,34 @@ React Native ExecuTorch conecta React Native con las capacidades nativas de la p
2730
[![Versión en npm](https://img.shields.io/npm/v/react-native-executorch?color=00008B)](https://www.npmjs.com/package/react-native-executorch)
2831
[![CI](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml/badge.svg)](https://github.com/software-mansion/react-native-executorch/actions/workflows/ci.yml)
2932

30-
**Tabla de contenidos:**
33+
<details>
34+
<summary><strong> :blue_book: Tabla de contenidos </strong></summary>
3135

3236
- [:yin_yang: Versiones compatibles](#yin_yang-versiones-compatibles)
33-
- [:books: Documentación](#books-documentación)
3437
- [:earth_africa: Ejemplo del mundo real](#earth_africa-ejemplo-del-mundo-real)
3538
- [:llama: Inicio rápido - Ejecutar Llama](#llama-inicio-rápido---ejecutar-llama)
3639
- [:calling: Aplicaciones de demostración](#calling-aplicaciones-de-demostración)
3740
- [:robot: Modelos listos para usar](#robot-modelos-listos-para-usar)
41+
- [:books: Documentación](#books-documentación)
3842
- [:balance_scale: Licencia](#balance_scale-licencia)
3943
- [:soon: ¿Qué sigue?](#soon-qué-sigue)
4044

45+
</details>
46+
4147
## :yin_yang: Versiones compatibles
4248

43-
Las versiones mínimas compatibles son:
44-
* iOS 17.0
45-
* Android 13
46-
* React Native 0.76
49+
Las versiones mínimas compatibles son:
50+
51+
- iOS 17.0
52+
- Android 13
53+
- React Native 0.76
4754

4855
> [!IMPORTANT]
4956
> React Native ExecuTorch solo admite la [nueva arquitectura de React Native](https://reactnative.dev/architecture/landing-page).
5057
51-
## :books: Documentación
52-
53-
Consulta cómo nuestra biblioteca puede ayudarte a crear funciones de IA en React Native visitando nuestra documentación:
54-
https://docs.swmansion.com/react-native-executorch
55-
5658
## :earth_africa: Ejemplo del mundo real
5759

58-
React Native ExecuTorch impulsa [Private Mind](https://github.com/software-mansion-labs/private-mind), una aplicación móvil de IA centrada en la privacidad disponible en [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) y [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
60+
React Native ExecuTorch impulsa [Private Mind](https://privatemind.swmansion.com/), una aplicación móvil de IA centrada en la privacidad disponible en [App Store](https://apps.apple.com/gb/app/private-mind/id6746713439) y [Google Play](https://play.google.com/store/apps/details?id=com.swmansion.privatemind).
5961

6062
<img width="2720" height="1085" alt="Promoción de Private Mind" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
6163

@@ -77,11 +79,7 @@ yarn expo run:< ios | android >
7779
Agrega esto a tu archivo de componente:
7880

7981
```tsx
80-
import {
81-
useLLM,
82-
LLAMA3_2_1B,
83-
Message
84-
} from 'react-native-executorch';
82+
import { useLLM, LLAMA3_2_1B, Message } from 'react-native-executorch';
8583

8684
function MyComponent() {
8785
// Inicializa el modelo 🚀
@@ -91,11 +89,12 @@ function MyComponent() {
9189
```
9290

9391
### :three: ¡Ejecuta el modelo!
92+
9493
```tsx
9594
const handleGenerate = async () => {
9695
const chat: Message[] = [
9796
{ role: 'system', content: 'Eres un asistente útil' },
98-
{ role: 'user', content: '¿Cuál es el significado de la vida?' }
97+
{ role: 'user', content: '¿Cuál es el significado de la vida?' },
9998
];
10099

101100
// Generación de chat
@@ -130,7 +129,12 @@ yarn expo run:< ios | android >
130129
131130
## :robot: Modelos listos para usar
132131

133-
Nuestra biblioteca incluye varios modelos de IA listos para usar; la lista completa está disponible en la documentación. Si te interesa ejecutar tu propio modelo de IA, primero debes exportarlo al formato `.pte`. Las instrucciones para hacerlo están disponibles en la [API de Python](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) y en el [README de optimum-executorch]((https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately)).
132+
Nuestra biblioteca incluye varios modelos de IA listos para usar; la lista completa está disponible en la documentación. Si te interesa ejecutar tu propio modelo de IA, primero debes exportarlo al formato `.pte`. Las instrucciones para hacerlo están disponibles en la [API de Python](https://docs.pytorch.org/executorch/stable/using-executorch-export.html) y en el [README de optimum-executorch](<(https://github.com/huggingface/optimum-executorch?tab=readme-ov-file#option-2-export-and-load-separately)>).
133+
134+
## :books: Documentación
135+
136+
Consulta cómo nuestra biblioteca puede ayudarte a crear funciones de IA en React Native visitando nuestra documentación:
137+
https://docs.swmansion.com/react-native-executorch
134138

135139
## :balance_scale: Licencia
136140

@@ -144,4 +148,4 @@ Para conocer nuestros próximos planes y desarrollos, visita nuestros [hitos](ht
144148

145149
Desde 2012, [Software Mansion](https://swmansion.com) es una agencia de software con experiencia en el desarrollo de aplicaciones web y móviles. Somos colaboradores principales de React Native y expertos en resolver todo tipo de problemas relacionados con esta tecnología. Podemos ayudarte a construir tu próximo producto soñado – [Contrátanos](https://swmansion.com/contact/projects?utm_source=react-native-executorch&utm_medium=readme).
146150

147-
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-executorch-github 'Software Mansion')](https://swmansion.com)
151+
[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-executorch-github 'Software Mansion')](https://swmansion.com)

0 commit comments

Comments
 (0)