Skip to content

Commit e15993b

Browse files
committedJul 23, 2024
docs: add readme
1 parent 3e73f50 commit e15993b

File tree

1 file changed

+3
-20
lines changed

1 file changed

+3
-20
lines changed
 

‎README.md

+3-20
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,9 @@
11
# react-native-ai
22

3-
3+
Run LLM locally in React Native app via Universal [MLC LLM Engine](https://github.com/mlc-ai/mlc-llm) with compatibility for [Vercel AI SDK](https://sdk.vercel.ai/docs/).
44

5-
## Installation
6-
7-
```sh
8-
npm install react-native-ai
9-
```
10-
11-
## Usage
12-
13-
```js
14-
import { multiply } from 'react-native-ai';
15-
16-
// ...
17-
18-
const result = await multiply(3, 7);
19-
```
20-
21-
## Contributing
22-
23-
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
5+
> [!CAUTION]
6+
> This projects is an experimental project and is not ready for production!
247
258
## License
269

0 commit comments

Comments
 (0)