Skip to content

Commit 712989d

Browse files
authored
Update README.md
1 parent a31d565 commit 712989d

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

README.md

Lines changed: 26 additions & 20 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,38 @@ 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)
36+
- [:yin_yang: Supported Versions](#yin_yang-supported-versions)
3337
- [:books: Documentation](#books-documentation)
34-
- [:earth_africa: Real-World Example](#earth_africa-real-world-example)
38+
- [:earth_africa: Real-world Example](#earth_africa-real-world-example)
3539
- [:llama: Quickstart - Running Llama](#llama-quickstart---running-llama)
36-
- [:calling: Demo apps](#calling-demo-apps)
37-
- [:robot: Ready-made models](#robot-ready-made-models)
40+
- [:calling: Demo Apps](#calling-demo-apps)
41+
- [:robot: Ready-made Models](#robot-ready-made-models)
3842
- [:balance_scale: License](#balance_scale-license)
39-
- [:soon: What's next?](#soon-whats-next)
43+
- [:soon: What's Next?](#soon-whats-next)
44+
45+
</details>
4046

41-
## :yin_yang: Supported versions
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
5157
## :books: Documentation
5258

5359
Check out how our library can help you build your React Native AI features by visiting our docs:
5460
https://docs.swmansion.com/react-native-executorch
5561

56-
## :earth_africa: Real-World Example
62+
## :earth_africa: Real-world Example
5763

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).
64+
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).
5965

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

@@ -90,7 +96,7 @@ function MyComponent() {
9096
}
9197
```
9298

93-
### :three: **Run the model!**
99+
### :three: **Run the Model!**
94100

95101
```tsx
96102
const handleGenerate = async () => {
@@ -105,7 +111,7 @@ const handleGenerate = async () => {
105111
};
106112
```
107113

108-
## :calling: Demo apps
114+
## :calling: Demo Apps
109115

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

@@ -129,15 +135,15 @@ yarn expo run:< ios | android >
129135
> [!WARNING]
130136
> 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.
131137
132-
## :robot: Ready-made models
138+
## :robot: Ready-made Models
133139

134140
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).
135141

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

0 commit comments

Comments
 (0)