breautek commented on code in PR #638: URL: https://github.com/apache/cordova-plugin-file/pull/638#discussion_r1803824180
########## README.md: ########## @@ -27,18 +27,18 @@ description: Read/write files on the device. 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 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) +This plugin is based on several specs: +- The HTML5 File API http://www.w3.org/TR/FileAPI + - Active spec +- The Directories and System extensions: 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 + - This spec is discontinued +- The FileWriter spec: http://dev.w3.org/2009/dap/file-system/file-writer.html + - This spec is discontinued + +There are new specs, which could eventually replace the discontinued specs: +- File System: https://fs.spec.whatwg.org +- File System Access: https://wicg.github.io/file-system-access Review Comment: I feel like the README should pertain to the current state of the plugin, so I don't think these details are relevant. It's not the concern of the end-user if the plugin could potentially be using a newer specification in the future. I think we can get the same point across while being less wordy by doing something like: ```markdown This plugin implements a File API allowing read/write access to files residing on the device, based on the following W3C specifications: - [HTML5 File API](http://www.w3.org/TR/FileAPI) - [File API: Directories and System](http://www.w3.org/TR/2012/WD-file-system-api-20120417)<sup>1</sup> <sup>2</sup> - [File API: Writer](https://www.w3.org/TR/2012/WD-file-writer-api-20120417/)<sup>1</sup> <sup>2</sup> <sup>1</sup> These specifications are discontinued and the file plugin may not have the entire specification implemented. <sup>2</sup> The plugin implementation has promise support added on. ``` What do you think? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org For additional commands, e-mail: issues-h...@cordova.apache.org
