You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by pu...@apache.org on 2014/06/24 00:36:29 UTC
git commit: updated spec links in docs ( en only )
Repository: cordova-plugin-file
Updated Branches:
refs/heads/master 1bb411b1a -> 29c139b87
updated spec links in docs ( en only )
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/commit/29c139b8
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/tree/29c139b8
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/diff/29c139b8
Branch: refs/heads/master
Commit: 29c139b879f97662d895ff1eab4565ce27b88f08
Parents: 1bb411b
Author: Jesse MacFadyen <pu...@gmail.com>
Authored: Mon Jun 23 15:36:21 2014 -0700
Committer: Jesse MacFadyen <pu...@gmail.com>
Committed: Mon Jun 23 15:36:21 2014 -0700
----------------------------------------------------------------------
doc/index.md | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/blob/29c139b8/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index 504b493..a6dc97e 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -19,9 +19,25 @@
# org.apache.cordova.file
-This plugin provides the [HTML5 Filesystem API](http://dev.w3.org/2009/dap/file-system/pub/FileSystem/). For usage, refer
-to HTML5 Rocks' [FileSystem article](http://www.html5rocks.com/en/tutorials/file/filesystem/)
-on the subject. For an overview of other storage options, refer to Cordova's
+
+This plugin implements a File API allowing read/write access to files residing on the device.
+
+This plugin is based on several specs, including :
+The HTML5 File API
+[http://www.w3.org/TR/FileAPI/](http://www.w3.org/TR/FileAPI/)
+
+The (now-defunct) Directories and System extensions
+Latest:
+[http://www.w3.org/TR/2012/WD-file-system-api-20120417/](http://www.w3.org/TR/2012/WD-file-system-api-20120417/)
+Although most of the plugin code was written when an earlier spec was current:
+[http://www.w3.org/TR/2011/WD-file-system-api-20110419/](http://www.w3.org/TR/2011/WD-file-system-api-20110419/)
+
+It also implements the FileWriter spec :
+[http://dev.w3.org/2009/dap/file-system/file-writer.html](http://dev.w3.org/2009/dap/file-system/file-writer.html)
+
+For usage, please refer to HTML5 Rocks' excellent [FileSystem article.](http://www.html5rocks.com/en/tutorials/file/filesystem/)
+
+For an overview of other storage options, refer to Cordova's
[storage guide](http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html).
## Installation