Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gtokman committed Aug 27, 2023
1 parent 163e151 commit 4daee90
Showing 1 changed file with 34 additions and 5 deletions.
39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,50 @@
# @candlefinance/react-native-openai
<div align="center">
<img margin="auto" width="1000px" src="https://github.com/candlefinance/react-native-openai/assets/12258850/cba19df9-1083-4d43-a291-ffdcd5cf6c7c" alt="Candle / OpenAI">
</div>

OpenAI API for React Native
<br/>

<div align="center">
<img alt="npm downloads" src="https://img.shields.io/npm/dw/@candlefinance/react-native-openai?logo=npm&label=NPM%20downloads&cacheSeconds=3600"/>
<img alt="twitter users online" src="https://img.shields.io/twitter/url/https/twitter.com/candlefinance.svg?style=social&label=Follow%20%40candlefinance" />
<img alt="discord users online" src="https://img.shields.io/discord/986610142768406548?logo=discord&label=Discord&cacheSeconds=3600" />
</div>

<br/>

<h1 align="center">
Lightweight OpenAI API for React Native
</h1>

-

## Installation

```sh
npm install @candlefinance/react-native-openai
yarn add @candlefinance/react-native-openai
```

## Usage

```js
import { multiply } from '@candlefinance/react-native-openai';

// ...
const openAI = new OpenAI('API_KEY', 'ORG_ID');

const [result, setResult] = React.useState('');

React.useEffect(() => {
openAI.addListener('onMessageReceived', (event) => {
setResult((message) => message + event.payload.message);
});

return () => {
openAI.removeListener('onMessageReceived');
};
}, []);

const result = await multiply(3, 7);
// Create a new completion
openAI.stream(e.nativeEvent.text);
```

## Contributing
Expand Down

0 comments on commit 4daee90

Please sign in to comment.