Change README.md

README.md

@@ -1,6 +1,4 @@
-# react-native-fetch-blob [![npm version](https://img.shields.io/badge/npm package-0.6.0-brightgreen.svg?style=flat-square)](https://badge.fury.io/js/react-native-fetch-blob?style=flat-square) ![](https://img.shields.io/badge/PR-Welcome-brightgreen.svg?style=flat-square)
-
-# v0.6.0 WIP README.md
+# react-native-fetch-blob [![npm version](https://img.shields.io/badge/npm package-0.5.3-brightgreen.svg)](https://badge.fury.io/js/react-native-fetch-blob) ![](https://img.shields.io/badge/PR-Welcome-brightgreen.svg) ![](https://img.shields.io/badge/in progress-0.6.0-yellow.svg)
 
 A module provides upload, download, and files access API. Supports file stream read/write for process large files.
 
@@ -28,6 +26,7 @@ This update is `backward-compatible` generally you don't have to change existing
  * [File access](#user-content-file-access)
  * [File stream](#user-content-file-stream)
  * [Manage cached files](#user-content-manage-cached-files)
+ * [Self-Signed SSL Server](#user-content-selfsigned-ssl-server)
 * [API](#user-content-api)
  * [config](#user-content-configoptionsrnfetchblobconfigfetch)
  * [fetch](#user-content-fetchmethod-url-headers-bodypromisefetchblobresponse)
@@ -305,7 +304,7 @@ In `version >= 0.4.2` it is possible to know the upload/download progress.
 
 #### Android Media Scanner, and Download Manager Support
 
-If you want to make a file in `External Storage` becomes visible in Picture, Downloads, or other built-in apps, you will have to use `Media Scanner` or `Download Manager`. 
+If you want to make a file in `External Storage` becomes visible in Picture, Downloads, or other built-in apps, you will have to use `Media Scanner` or `Download Manager`.
 
 **Media Scanner**
 
@@ -336,12 +335,12 @@ When download large files on Android it is recommended to use `Download Manager`
 RNFetchBlob
     .config({
         // Optional, if not specified, the file will download to system default path
-        path : DOWNLOAD_DEST, 
+        path : DOWNLOAD_DEST,
         addAdnroidDownloads : {
             useDownloadManager : true, // <-- this is the only thing required
             // Optional, override notification setting (default to true)
             notification : false,
-            // Optional, but recommended since android DownloadManager will fail when 
+            // Optional, but recommended since android DownloadManager will fail when
             // the url does not contains a file extension, by default the mime type will be text/plain
             mime : 'text/plain',
             description : 'File downloaded by download manager.'
@@ -508,6 +507,20 @@ You can also grouping requests by using `session` API, and use `dispose` to remo
 
 ```
 
+#### Self-Signed SSL Server
+
+By default, react-native-fetch-blob does NOT allow connection to unknown certification provider since it's dangerous. If you're going to connect a server with self-signed certification, add `trusty` to `config`. This function is available for version >= `0.5.3`
+
+```js
+RNFetchBlob.config({
+  trusty : true
+})
+.then('GET', 'https://mysite.com')
+.then((resp) => {
+  // ...
+})
+```
+
 ---
 
 ## API
@@ -783,10 +796,14 @@ Connect `Media Scanner` and scan the file. see [Android Media Scanner, and Downl
 
 A set of configurations that will be injected into a `fetch` method, with the following properties.
 
+#### trusty:boolean
+  `0.5.3`
+  Set this property to `true` will allow the request create connection with server have self-signed SSL certification. This is not recommended to use in production.
+
 #### fileCache:boolean
   Set this property to `true` will makes response data of the `fetch` stored in a temp file, by default the temp file will stored in App's own root folder with file name template `RNFetchBlob_tmp${timestamp}`.
 #### appendExt:string
-  Set this propery to change temp file extension that created by `fetch` response data.
+  Set this property to change temp file extension that created by `fetch` response data.
 #### path:string
   When this property has value, `fetch` API will try to store response data in the path ignoring `fileCache` and `appendExt` property.
 #### addAndroidDownloads:object (Android only)
@@ -854,6 +871,7 @@ A `session` is an object that helps you manage files. It simply maintains a list
 
 | Version | |
 |---|---|
+| 0.5.3 | Add API for access untrusted SSL server |
 | 0.5.2 | Fix improper url params bug [#26](https://github.com/wkh237/react-native-fetch-blob/issues/26) and change IOS HTTP implementation from NSURLConnection to NSURLSession |
 | 0.5.0 | Upload/download with direct access to file storage, and also added file access APIs |
 | 0.4.2 | Supports upload/download progress |