From e15993bf72657d5dad3658c897f797631faca1a7 Mon Sep 17 00:00:00 2001 From: szymonrybczak Date: Tue, 23 Jul 2024 12:12:18 +0200 Subject: [PATCH] docs: add readme --- README.md | 23 +++-------------------- 1 file changed, 3 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index df1769d..56a98dc 100644 --- a/README.md +++ b/README.md @@ -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