Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
szymonrybczak committed Jul 23, 2024
1 parent 3e73f50 commit e15993b
Showing 1 changed file with 3 additions and 20 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,9 @@
# react-native-ai

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/).

## Installation

```sh
npm install react-native-ai
```

## Usage

```js
import { multiply } from 'react-native-ai';

// ...

const result = await multiply(3, 7);
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
> [!CAUTION]
> This projects is an experimental project and is not ready for production!
## License

Expand Down

0 comments on commit e15993b

Please sign in to comment.