Skip to content

Commit 89c9169

Browse files
author
Vincent (Wen Yu) Ge
authored
Update README.md
1 parent 5882ad1 commit 89c9169

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Appwrite Web SDK
1+
# Appwrite React Native SDK
22

33
![License](https://img.shields.io/github/license/appwrite/sdk-for-react-native.svg?style=flat-square)
44
![Version](https://img.shields.io/badge/api%20version-1.4.12-blue.svg?style=flat-square)
@@ -8,7 +8,7 @@
88

99
**This SDK is compatible with Appwrite server version 1.4.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).**
1010

11-
Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
11+
Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the React Native SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
1212

1313
![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
1414

@@ -20,12 +20,24 @@ To install
2020
npm install react-native-appwrite react-native-fs react-native-url-polyfill --save
2121
```
2222

23+
For iOS apps, you will need to install cocoapod dependencies.
24+
25+
```sh
26+
cd iOS && pod install && cd ..
27+
```
28+
2329
## Getting Started
2430

2531
### Add your Platform
26-
For you to init your SDK and interact with Appwrite services you need to add a web platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before and click the 'Add Platform' button.
32+
If this is your first time using Appwrite, create an account and create your first project.
33+
34+
Then, under **Add a platform**, add a **Android app** or a **Apple app**. You can skip optional steps.
35+
36+
#### iOS steps
37+
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.
2738

28-
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.
39+
#### Android steps
40+
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.
2941

3042
## Setup
3143

@@ -46,7 +58,7 @@ const client = new Client();
4658
client
4759
.setEndpoint('http://localhost/v1') // Your Appwrite Endpoint
4860
.setProject('455x34dfkj') // Your project ID
49-
.setPlatform('com.example.myappwriteapp') // YOUR application ID
61+
.setPlatform('com.example.myappwriteapp') // Your application ID or bundle ID.
5062
;
5163
```
5264

@@ -63,7 +75,6 @@ account.create(ID.unique(), '[email protected]', 'password', 'Jane Doe')
6375
}, function (error) {
6476
console.log(error);
6577
});
66-
6778
```
6879

6980
### Full Example
@@ -91,16 +102,14 @@ account.create(ID.unique(), '[email protected]', 'password', 'Jane Doe')
91102

92103
### Learn more
93104
You can use the following resources to learn more and get help
94-
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-react-native)
105+
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/quick-starts/react-native)
95106
- 📜 [Appwrite Docs](https://appwrite.io/docs)
96107
- 💬 [Discord Community](https://appwrite.io/discord)
97108
- 🚂 [Appwrite React Native Playground](https://github.com/appwrite/playground-for-react-native)
98109

99110

100111
## Contribution
101-
102112
This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
103113

104114
## License
105-
106-
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.
115+
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

0 commit comments

Comments
 (0)