Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Appwrite React Native SDK
# Appwrite React Native SDK [BETA]

![License](https://img.shields.io/github/license/appwrite/sdk-for-react-native.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.4.12-blue.svg?style=flat-square)
Expand All @@ -17,13 +17,7 @@ Appwrite is an open-source backend as a service server that abstract and simplif
To install

```bash
npm install react-native-appwrite react-native-fs react-native-url-polyfill --save
```

For iOS apps, you will need to install cocoapod dependencies.

```sh
cd iOS && pod install && cd ..
npx expo install react-native-appwrite react-native-url-polyfill
```

## Getting Started
Expand All @@ -37,22 +31,16 @@ Then, under **Add a platform**, add a **Android app** or a **Apple app**. You ca
Add your app **name** and **Bundle ID**. You can find your **Bundle Identifier** in the **General** tab for your app's primary target in XCode.

#### Android steps
Add your app's **name** and **package name**, Your package name is generally the **applicationId** in your app-level [build.gradle](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/build.gradle#L41) file.
Add your app's **name** and **package name**, Your package name is generally the **applicationId** in your app-level `build.gradle` file.

## Setup

On `index.js` add import for `react-native-url-polyfill`

```
import 'react-native-url-polyfill/auto'
```

### Init your SDK
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.

```js
import { Client } from 'react-native-appwrite';
// Init your Web SDK
// Init your react-native SDK
const client = new Client();

client
Expand Down
Loading