Merge pull request #9 from aliyun/luozhang

example optimize and  docs

Example/App.js

@@ -14,24 +14,22 @@ import { BucketManager } from './Component/BucketManager'
 import { ObjectManager } from './Component/ObjectManager'
 
 import AliyunOSS from 'aliyun-oss-react-native'
+
 //open log 
 AliyunOSS.enableDevMode()
+
 // defalut configraiton
 const configuration = {
    maxRetryCount: 3,  
    timeoutIntervalForRequest: 30,
    timeoutIntervalForResource: 24 * 60 * 60
 };
-const config = {
-  AccessKey: 'XXX',
-  SecretKey: 'XXX',
-};
-const endPoint = 'oss-cn-zhangjiakou.aliyuncs.com';
-const companyserver = "http://XXX:PORT";
-const familyserver = "http://XXX:PORT";
 
-// AliyunOSS.initWithPlainTextAccessKey(config.AccessKey, config.SecretKey, endPoint, configuration);
-AliyunOSS.initWithServerSTS(familyserver,endPoint, configuration)
+const endPoint = 'oss-cn-XXX.aliyuncs.com';
+const authserver = "http://XXX:PORT";
+
+// initWithServerSTS to auth
+AliyunOSS.initWithServerSTS(authserver,endPoint, configuration)
 
 type Props = {};
 

Example/Component/AuthManager.js

@@ -12,9 +12,9 @@ import {
 
 
 const configuration = {
-   maxRetryCount: 3,  
-   timeoutIntervalForRequest: 30,
-   timeoutIntervalForResource: 24 * 60 * 60
+  maxRetryCount: 3,  
+  timeoutIntervalForRequest: 30,
+  timeoutIntervalForResource: 24 * 60 * 60
 };
 
 const config = {

README-CN.md

@@ -139,21 +139,21 @@ AliyunOSS.initWithServerSTS("/***http://ip:端口/****/",endPoint, configuration
 
 1. `npm istall`
 2. 修改config中accessKeyId 和 accessKeySecret
-3. node index.js,端口默认9000，鉴权服务地址为:(http|https)://ip.com:9000/
+3. node index.js,端口默认9000，鉴权服务地址为:(http|https)://ip:9000/
 
 *  step-5:
 
 ```javascript
-    <!-- 备注：目前接口仅暴漏filePath,上传路径为file:/// -->
-    AliyunOSS.asyncUpload(bucketname, objectkey, filePath).then( (res) => {
-        <!-- log的查看可以通过React Native自带的调试工具也可通过XCode Log控制台进行查看 -->
-        console.log(res)
-    }).catch((error)=>{
-        console.log(error)
-    })
-    <!-- 监听上传事件和上传进度-->
-   const downloadProgress = p => console.log(p.currentSize / p.totalSize);
-   AliyunOSS.addEventListener('uploadProgress', downloadProgress);
+  <!-- 备注：目前接口仅暴漏filePath,上传路径为file:/// -->
+  AliyunOSS.asyncUpload(bucketname, objectkey, filePath).then( (res) => {
+    <!-- log的查看可以通过React Native自带的调试工具也可通过XCode Log控制台进行查看 -->
+    console.log(res)
+  }).catch((error)=>{
+    console.log(error)
+  })
+  <!-- 监听上传事件和上传进度-->
+ const downloadProgress = p => console.log(p.currentSize / p.totalSize);
+ AliyunOSS.addEventListener('uploadProgress', downloadProgress);
 ```
 
 ## 接口
@@ -167,9 +167,7 @@ initWithPlainTextAccessKey | 支持| 支持
 initWithSigner | 支持| 支持
 initWithSecurityToken | 支持| 支持
 initWithServerSTS  | 支持| 支持
-asyncUpload  | 支持| 支持
-asyncAppendObject  ||
-asyncResumableUpload  ||
+asyncUpload  | 支持| 支持 |
 initMultipartUpload  | 支持| 支持
 multipartUpload   | 支持| 支持
 listParts   | 支持| 支持
@@ -376,7 +374,7 @@ AliyunOSS.asyncListBuckets().then((e) => {
 
 ## 示例
 
-仓库Example中提供了React Native android和iOS端运行demo，Android为Example下的android工程，iOS为Example下的NativeAddRN工程，目前Example提供了所有已开发的API DEMO，还在完善中，欢迎参与共建。如何运行Example呢？
+仓库Example中提供了React Native android和iOS端运行demo，Android为Example下的android工程，iOS为Example下的iOS工程，目前Example提供了所有已开发的API DEMO，还在完善中，欢迎参与共建。如何运行Example呢？
 
 * step-1:克隆项目并安装依赖包
 

README.md

@@ -71,38 +71,39 @@ pod 'aliyun-oss-react-native', :path => '../node_modules/aliyun-oss-react-native
 
 #### Android
 1. Add the following lines to `android/settings.gradle`:
-    ```gradle
-    include ':react-native-rn-sdk'
-    project(':react-native-rn-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/aliyun-oss-rn-sdk/android')
-    ```
 
-2. Add the compile line to the dependencies in `android/app/build.gradle`:
-    ```gradle
-    dependencies {
-        compile project(':aliyun-oss-react-native')
-    }
-    ```
+```gradle
+include ':react-native-rn-sdk'
+project(':react-native-rn-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/aliyun-oss-rn-sdk/android')
+```
 
+2. Add the compile line to the dependencies in `android/app/build.gradle`:
+```gradle
+dependencies {
+  compile project(':aliyun-oss-react-native')
+}
+```
 3. Add the required permissions in `AndroidManifest.xml`:
-    ```xml
-       <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
-       <uses-permission android:name="android.permission.CAMERA" />
-    ```
+
+  ```xml
+     <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
+     <uses-permission android:name="android.permission.CAMERA" />
+  ```
 4. Add the import and link the package in `MainApplication.java`:
 
-    ```java
-      import com.reactlibrary.RNAliyunOssPackage;
+```java
+import com.reactlibrary.RNAliyunOssPackage;
 
-       public class MainApplication extends Application implements ReactApplication {
-        @Override
-          protected List<ReactPackage> getPackages() {
-            return Arrays.<ReactPackage>asList(
-                new MainReactPackage(),
-                  new RNAliyunOssPackage()
-            );
-          }
-       }
-      ```
+ public class MainApplication extends Application implements ReactApplication {
+  @Override
+    protected List<ReactPackage> getPackages() {
+      return Arrays.<ReactPackage>asList(
+        new MainReactPackage(),
+        new RNAliyunOssPackage()
+    );
+  }
+}
+```
 
 ## Usage
 
@@ -170,8 +171,6 @@ initWithSigner  |Y|Y
 initWithSecurityToken   |Y|Y
 initWithServerSTS   |Y|Y
 asyncUpload   |Y| Y
-asyncAppendObject  ||
-asyncResumableUpload  ||
 initMultipartUpload |Y|Y
 multipartUpload  | Y | Y
 listParts |Y|Y
@@ -347,29 +346,29 @@ AliyunOSS.asyncListBuckets().then((e) => {
 ```
 ### doesObjectExist
 
-```
- AliyunOSS.doesObjectExist('luozhang001','xx.png').then((e)=>{
+```javascript
+ AliyunOSS.doesObjectExist('luozhang001','xx.png').then( (e) => {
+    console.log(e)
+  }).catch((e) => {
     console.log(e)
-  }).catch((e)=>{
-     console.log(e)
   })
 ```
 
 ### asyncCopyObject
 
-```
- AliyunOSS.asyncCopyObject('luozhang001',"2.png","luozhang002","sbsbsb").then((e)=>{
-      console.log(e)
-    }).catch((e)=>{
-      console.log("xxxx")
-      console.log(e)
-    })
+```javascript
+ AliyunOSS.asyncCopyObject('luozhang001',"2.png","luozhang002","sbsbsb").then( (e) => {
+    console.log(e)
+  }).catch((e)=>{
+    console.log("xxxx")
+    console.log(e)
+  })
 ```
 ### asyncDeleteObject
 
-```
+```javascript
  AliyunOSS.asyncDeleteObject('luozhang001','2.png').then((e)=>{
-     Alert.alert(e)
+    Alert.alert(e)
   }).catch((e)=>{
     console.log(e)
   })
@@ -377,7 +376,7 @@ AliyunOSS.asyncListBuckets().then((e) => {
 
 ## DEMO
 
-In the repository, we prodive RN SDK DEMO in the Example folder including andriod and ios,`Example/android` provide the android demo;`Example/NativeAddRN` provide the ios demo.Welcome to join us, how to run the Example ?
+In the repository, we prodive RN SDK DEMO in the Example folder including andriod and ios,`Example/android` provide the android demo;`Example/iOS` provide the ios demo.Welcome to join us, how to run the Example ?
 
 * step-1:clone the project and install some dependencies