udate SHARE.md

README.md

@@ -42,12 +42,12 @@ dependencies:
 isWeChatRegistered = YES;
  ```
 
-
     注意：尽管可以通过Fluwx完成微信注册，但一些操作依然需要在对应平台进行设置，如配置iOS的URLSchema等。
 
 
 
 ### 传送门
+* [分享功能](docs/SHARE.md)。
 * [发送Auth认证](docs/SEND_AUTH.md)。
 ## 开始分享
 以分享文本和网址为例：

docs/SHARE.md

-## 图片处理
-图片仅支持```png```和```jpg```。
-目前所有需要图片的地方支持网络图片及assets图片。</br>
-使用assets图片需要添加```assets://```。</br>
-也可以在assets图片添加```?package=package_name```以读取指定包的图片。</br>
-未来可能支持```file://```。</br>
-如果不指定schema或者schema错误,将会被处理为网络图片，请谨慎。</br>
-## 注意
-所有涉及缩略的最好给Fluwx一个合格的图片（小于32k,小程序小于120k），否则Fluwx将会对图片进行处理，这样做的结果可能并不是你所预期的，如缩略图被缩放。
\ No newline at end of file
+### 简述
+    目前```Fluwx```并不是支持所有的分享类型，目前仅支持文本分享、图片分享、网址分享
+    音乐、视频以及小程序的分享。未来会考虑增加更多支持。
+
+
+ >  注意：目前分享中涉及到图片的地方仅支持```png```和```jpg```，支持网络图片及```assets```图片。<br>
+ >  使用assets图片需要添加```assets://```。<br>
+ >  也可以在```assets```图片添加```?package=package_name```以读取指定包的图片。<br>
+ >  未来可能支持```file://```,目前以```file://```图片不会做任何处理。<br>
+ >  如果不指定schema或者schema错误,将会被处理为网络图片，请谨慎。<br>
+ >  由于微信的限制，一般的缩略图要小于32k(小程序的缩略图要小于120k)，所以在使用缩略的时候<br>
+ >  很有必要使用一张合格的缩略图，否则```Fluwx```进行压缩，其结果可能并不是你所预期的。
+
+### 分享去处
+    绝大部分分享可以分享到会话，朋友圈，收藏（小程序目前只能分享到会话）。默认分享到会话。
+
+```dart
+    ///[WeChatScene.SESSION]会话
+    ///[WeChatScene.TIMELINE]朋友圈
+    ///[WeChatScene.FAVORITE]收藏
+    enum WeChatScene {
+      SESSION,
+      TIMELINE,
+      FAVORITE
+      }
+```
+### 返回值处理
+    ```fluwx.share(model)```返回的是一个```Map```：
+```dart
+    {
+       "platform":"Android",//或者iOS
+       result:true //或者false，取决于WXApi.sendRequest()的结果
+     }
+```
+
+### 分享文本
+```dart
+  fluwx.share(WeChatShareTextModel(
+      text: "text from fluwx",
+      transaction: "transaction}",//仅在android上有效，下同。
+      scene: scene
+    ));
+```
+### 分享图片
+```dart
+ fluwx.share(WeChatShareImageModel(
+        image: _imagePath,
+        thumbnail: _thumbnail,
+        transaction: _imagePath,
+        scene: scene,
+        description: "image"));
+```
+>  注意：如果`不指定 ```thumbnail```，那么```Fluwx```将尝试从```image```中获取缩略图。
+
+### 分享音乐
+```dart
+  var model = WeChatShareMusicModel(
+      title: _title,
+      description: _description,
+      transaction: "music",
+      musicUrl: _musicUrl,
+      musicLowBandUrl: _musicLowBandUrl
+    );
+
+    fluwx.share(model);
+```dart
+    音乐的分享有两种：```musicUrl```和```musicLowBandUrl```。这两种形式是不共存的，如果
+    都二者都进行了赋值，那么只会读采```musicUrl```。
\ No newline at end of file

example/lib/share_music.dart

@@ -128,7 +128,7 @@ class _ShareMusicPageState extends State<ShareMusicPage> {
       description: _description,
       transaction: "music",
       musicUrl: _musicUrl,
-      musicLowBandDataUrl: _musicLowBandUrl
+        musicLowBandUrl: _musicLowBandUrl,
     );
 
     fluwx.share(model);