Skip to content

Commit 68a8d89

Browse files
committed
update readme
1 parent 6780db4 commit 68a8d89

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,28 @@
11
# Appwrite Web SDK
22

3-
![License](https://img.shields.io/github/license/appwrite/sdk-for-web.svg?style=flat-square)
3+
![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)
55
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
66
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
77
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
88

9-
**This SDK is compatible with Appwrite server version 1.4.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-web/releases).**
9+
**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

1111
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)
1212

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

1515
## Installation
1616

17-
### NPM
18-
19-
To install via [NPM](https://www.npmjs.com/):
17+
To install
2018

2119
```bash
22-
npm install appwrite --save
23-
```
24-
25-
If you're using a bundler (like [Rollup](https://rollupjs.org/) or [webpack](https://webpack.js.org/)), you can import the Appwrite module when you need it:
26-
27-
```js
28-
import { Client, Account } from "appwrite";
20+
npm install react-native-appwrite --save
2921
```
3022

31-
### CDN
32-
33-
To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
34-
35-
```html
36-
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
37-
```
38-
39-
4023
## Getting Started
4124

42-
### Add your Web Platform
25+
### Add your Platform
4326
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.
4427

4528
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.
@@ -54,6 +37,7 @@ const client = new Client();
5437
client
5538
.setEndpoint('http://localhost/v1') // Your Appwrite Endpoint
5639
.setProject('455x34dfkj') // Your project ID
40+
.setPlatform('com.example.myappwriteapp') // YOUR application ID
5741
;
5842
```
5943

@@ -81,6 +65,7 @@ const client = new Client();
8165
client
8266
.setEndpoint('http://localhost/v1') // Your Appwrite Endpoint
8367
.setProject('455x34dfkj')
68+
.setPlatform('com.example.myappwriteapp') // YOUR application ID
8469
;
8570

8671
const account = new Account(client);
@@ -96,10 +81,10 @@ account.create(ID.unique(), '[email protected]', 'password', 'Jane Doe')
9681

9782
### Learn more
9883
You can use the following resources to learn more and get help
99-
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-web)
84+
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-react-native)
10085
- 📜 [Appwrite Docs](https://appwrite.io/docs)
10186
- 💬 [Discord Community](https://appwrite.io/discord)
102-
- 🚂 [Appwrite Web Playground](https://github.com/appwrite/playground-for-web)
87+
- 🚂 [Appwrite React Native Playground](https://github.com/appwrite/playground-for-react-native)
10388

10489

10590
## Contribution

0 commit comments

Comments
 (0)