This is an automated email from the ASF dual-hosted git repository.
timbru31 pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/cordova-plugin-file-transfer.git
The following commit(s) were added to refs/heads/master by this push:
new 2d5d351 docs: undeprecate the plugin (#267)
2d5d351 is described below
commit 2d5d3519b95922aa77a1336c0a8764154c938511
Author: Tim Brust <[email protected]>
AuthorDate: Tue Aug 25 12:36:13 2020 +0000
docs: undeprecate the plugin (#267)
Co-authored-by: エリス <[email protected]>
---
README.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index b637446..ae19ffe 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,14 @@ description: Upload and download files.
# cordova-plugin-file-transfer
+# Usage notice
+
+With the new features introduced in the [Fetch
API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and the
[XMLHttpRequest](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest),
this plugin may not be needed any more for your use case. For small file
transfers, you probably won't require this plugin. But, if you plan to handle
large downloads, suffering from slow saving, timeouts, or crashes, this plugin
is better suited for your use case over the Fetch API or th [...]
+
+Migrating from this plugin to using the new features of
[XMLHttpRequest](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest),
is explained in this [Cordova blog
post](https://cordova.apache.org/blog/2017/10/18/from-filetransfer-to-xhr2.html).
+
+## Description
+
This plugin allows you to upload and download files.
This plugin defines global `FileTransfer`, `FileUploadOptions` constructors.
Although in the global scope, they are not available until after the
`deviceready` event.
@@ -42,10 +50,6 @@ function onDeviceReady() {
Report issues with this plugin on the [Apache Cordova issue
tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20File%20Transfer%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC)
-## Deprecated
-
-With the new features introduced in
[XMLHttpRequest](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest),
this plugin is not needed any more. Migrating from this plugin to using the
new features of
[XMLHttpRequest](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest),
is explained in this [Cordova blog
post](https://cordova.apache.org/blog/2017/10/18/from-filetransfer-to-xhr2.html).
-
## Installation
```bash
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
