Skip to content

Commit

Permalink
Quick readme to onboard customer
Browse files Browse the repository at this point in the history
  • Loading branch information
tom-quiltt committed Nov 3, 2023
1 parent 98de030 commit 3743fe7
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
28 changes: 27 additions & 1 deletion ECMAScript/react-native/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,30 @@
# Quiltt Connector React Native SDK
# @quiltt/react-native

[![npm version](https://badge.fury.io/js/@quiltt%2Freact-native.svg)](https://badge.fury.io/js/@quiltt%2Freact-native)
[![CI](https://github.com/quiltt/quiltt-public/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/quiltt/quiltt-public/actions/workflows/ci.yml)

`@quiltt/react-native` provides React Native Components for integrating Quiltt Connector into React Native and Expo applications.

## Installation

```shell
$ npm install @quiltt/react
# or
$ yarn add @quiltt/react
# or
# Please note that you will need to add `node-linker=hoisted` in `.npmrc` if you are using pnpm in expo app.`
$ pnpm add @quiltt/react
```

### QuilttConnector

Launch the [Quiltt Connector](https://www.quiltt.dev/guides/connector) in a webview.

`@quiltt/react-native` does not include any navigation library, you might want to navigate to a new "page" when using QuilttConnector to get the best result.

For simple usage of `react-navigation`, please see [App.tsx](ECMAScript/react-native/example/App.tsx) and [ConnectorScreen.tsx](ECMAScript/react-native/example/screens/ConnectorScreen.tsx).

#### Example

```typescript
import { useState } from 'react'
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ The Core package provides essential functionality for building Javascript-based
[![npm version](https://badge.fury.io/js/%40quiltt%2Freact.svg)](https://badge.fury.io/js/%40quiltt%2Freact)
The React package provides React Components and Hooks for integrating Quiltt into React-based applications.

### [@quiltt/react-native](ECMAScript/react-native#readme)

[![npm version](https://badge.fury.io/js/%40quiltt%2Freact-native.svg)](https://badge.fury.io/js/%40quiltt%2Freact-native)
The React Native package provides React Native Components for integrating Quiltt Connector into React Native and Expo applications.

## License

This repository and published packages are licensed under the terms of the MIT license. See the [LICENSE](LICENSE.md) file for more information.

0 comments on commit 3743fe7

Please sign in to comment.