Skip to content

Commit 4344c09

Browse files
authored
Add Real-World Example section to README (#537)
## Description Add Real-World Example section to README ### Introduces a breaking change? - [ ] Yes - [x] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [ ] Documentation update (improves or adds clarity to existing documentation) - [x] Other (chores, tests, code style improvements etc.) ### Checklist - [x] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [x] My changes generate no new warnings
1 parent c87c2d4 commit 4344c09

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ React Native ExecuTorch bridges the gap between React Native and native platform
2121
**Table of contents:**
2222

2323
- [:yin_yang: Supported versions](#yin_yang-supported-versions)
24-
- [:robot: Ready-made models](#robot-ready-made-models)
2524
- [:books: Documentation](#books-documentation)
25+
- [:earth_africa: Real-World Example](#earth_africa-real-world-example)
2626
- [:llama: Quickstart - Running Llama](#llama-quickstart---running-llama)
27-
- [:calling: Examples](#calling-examples)
27+
- [:calling: Demo apps](#calling-demo-apps)
28+
- [:robot: Ready-made models](#robot-ready-made-models)
2829
- [:balance_scale: License](#balance_scale-license)
2930
- [:soon: What's next?](#soon-whats-next)
3031

@@ -38,15 +39,17 @@ The minimal supported version are:
3839
> [!IMPORTANT]
3940
> React Native Executorch supports only the [New React Native architecture](https://reactnative.dev/architecture/landing-page).
4041
41-
## :robot: Ready-made models
42-
43-
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://pypi.org/project/executorch/).
44-
4542
## :books: Documentation
4643

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

47+
## :earth_africa: Real-World Example
48+
49+
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).
50+
51+
<img width="2720" height="1085" alt="Private Mind promo" src="https://github.com/user-attachments/assets/b12296fe-19ac-48fc-9726-da9242700346" />
52+
5053
## :llama: **Quickstart - Running Llama**
5154

5255
**Get started with AI-powered text generation in 3 easy steps!**
@@ -93,7 +96,7 @@ const handleGenerate = async () => {
9396
};
9497
```
9598

96-
## :calling: Examples
99+
## :calling: Demo apps
97100

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

@@ -117,6 +120,10 @@ yarn expo run:< ios | android >
117120
> [!WARNING]
118121
> 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.
119122
123+
## :robot: Ready-made models
124+
125+
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://pypi.org/project/executorch/).
126+
120127
## :balance_scale: License
121128

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

0 commit comments

Comments
 (0)