Skip to content

Commit 5882ad1

Browse files
committed
improve readme
1 parent 7dc986c commit 5882ad1

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Appwrite is an open-source backend as a service server that abstract and simplif
1717
To install
1818

1919
```bash
20-
npm install react-native-appwrite --save
20+
npm install react-native-appwrite react-native-fs react-native-url-polyfill --save
2121
```
2222

2323
## Getting Started
@@ -27,10 +27,19 @@ For you to init your SDK and interact with Appwrite services you need to add a w
2727

2828
From the options, choose to add a **Web** platform and add your client app hostname. By adding your hostname to your project platform you are allowing cross-domain communication between your project and the Appwrite API.
2929

30+
## Setup
31+
32+
On `index.js` add import for `react-native-url-polyfill`
33+
34+
```
35+
import 'react-native-url-polyfill/auto'
36+
```
37+
3038
### Init your SDK
3139
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.
3240

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

@@ -59,6 +68,7 @@ account.create(ID.unique(), '[email protected]', 'password', 'Jane Doe')
5968

6069
### Full Example
6170
```js
71+
import { Client, Account } from 'react-native-appwrite';
6272
// Init your Web SDK
6373
const client = new Client();
6474

0 commit comments

Comments
 (0)