Skip to content

Commit 10564f5

Browse files
committed
feat(docs): updates for 0.9
1 parent 5e79af0 commit 10564f5

File tree

2 files changed

+34
-18
lines changed

2 files changed

+34
-18
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
## 0.7.0
2+
- Support for Appwrite 0.9
3+
- Breaking - removed order type enum, now you should pass string 'ASC' or 'DESC'
4+
- Image Crop Gravity support in image preview service
5+
- New endpoint in Account getSession to get session by ID
6+
- Fix - issues with User-Agent when app name consisted of non-ASCII characters
7+
- Fix - issue with null Success and Failure URL in createOAuth2Session
8+
- Updated underlying dependencies
9+
110
## 0.6.3
211

312
- Removed default values, nothing should change in usage as default values are already allocated in server
@@ -116,4 +125,4 @@
116125
## 0.0.8
117126

118127
- Fixed compilation error in Client class
119-
- Shorter description for package
128+
- Shorter description for package

β€ŽREADME.mdβ€Ž

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,13 @@ pub get appwrite
3636
### Add your Flutter Platform
3737
To init your SDK and start interacting with Appwrite services, you need to add a new Flutter 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.
3838

39-
From the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for both iOS and Android.
39+
From the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for Android, iOS, Linux, Mac OS, Web and Windows.
4040

4141
If you are building your Flutter application for multiple devices, you have to follow this process for each different device.
4242

43-
#### iOS
44-
For **iOS** 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.
45-
46-
#### Android
47-
For **Android** add your app <u>name</u> and <u>package name</u>, Your package name is generally the applicationId in your app-level build.gradle file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
48-
49-
### iOS
50-
51-
The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.
52-
53-
1. In Xcode, open Runner.xcworkspace in your app's ios folder.
54-
2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
55-
3. Select the General tab.
56-
4. In Deployment Info, 'Target' select iOS 11.0
57-
5843
### Android
44+
For **Android** first add your app <u>name</u> and <u>package name</u>, Your package name is generally the **applicationId** in your app-level <a href="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/android/app/build.gradle#L41" target="_blank" rel="noopener">build.gradle</a> file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
45+
5946
In order to capture the Appwrite OAuth callback url, the following activity needs to be added to your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to replace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in your project settings screen in the console.
6047

6148
```xml
@@ -73,12 +60,31 @@ In order to capture the Appwrite OAuth callback url, the following activity need
7360
</manifest>
7461
```
7562

63+
### iOS
64+
For **iOS** first 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.
65+
66+
The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.
67+
68+
1. In Xcode, open Runner.xcworkspace in your app's ios folder.
69+
2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
70+
3. Select the General tab.
71+
4. In Deployment Info, 'Target' select iOS 11.0
72+
73+
### Linux
74+
For **Linux** add your app <u>name</u> and <u>package name</u>, Your package name is generally the **name** in your <a href="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1" target="_blank" rel="noopener">pubspec.yaml<a> file. If you cannot find the correct package name, run the application in linux, and make any request with proper exception handling, you should get the application ID needed to add in the received error message.
75+
76+
### Mac OS
77+
For **Mac OS** 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.
78+
7679
### Web
7780
Appwrite 0.7, and the Appwrite Flutter SDK 0.3.0 have added support for Flutter Web. To build web apps that integrate with Appwrite successfully, all you have to do is add a web platform on your Appwrite project's dashboard and list the domain your website will use to allow communication to the Appwrite API.
7881

7982
#### Flutter Web Cross-Domain Communication & Cookies
8083
While running Flutter Web, make sure your Appwrite server and your Flutter client are using the same top-level domain and the same protocol (HTTP or HTTPS) to communicate. When trying to communicate between different domains or protocols, you may receive HTTP status error 401 because some modern browsers block cross-site or insecure cookies for enhanced privacy. In production, Appwrite allows you set multiple [custom-domains](https://appwrite.io/docs/custom-domains) for each project.
8184

85+
### Windows
86+
For **Windows** add your app <u>name</u> and <u>package name</u>, Your package name is generally the **name** in your <a href="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1" target="_blank" rel="noopener">pubspec.yaml</a> file. If you cannot find the correct package name, run the application in windows, and make any request with proper exception handling, you should get the application id needed to add in the received error message.
87+
8288
### Init your SDK
8389

8490
<p>Initialize your SDK with your Appwrite server API endpoint and project ID, which can be found in your project settings page.
@@ -155,12 +161,13 @@ try {
155161
```
156162

157163
### Learn more
158-
You can use followng resources to learn more and get help
164+
You can use following resources to learn more and get help
159165
- πŸš€ [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)
160166
- πŸ“œ [Appwrite Docs](https://appwrite.io/docs)
161167
- πŸ’¬ [Discord Community](https://appwrite.io/discord)
162168
- πŸš‚ [Appwrite Flutter Playground](https://github.com/appwrite/playground-for-flutter)
163169

170+
164171
## Contribution
165172

166173
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.

0 commit comments

Comments
Β (0)