browser-nativefs - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "browser-nativefs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Native File System API with legacy fallback in the browser.",
@@ -20,6 +20,6 @@ "browser": "./dist/nativefs.mjs",
   "keywords": [
-    "Native",
-    "File",
-    "System",
-    "API"
+    "native file system",
+    "native file system api",
+    "native fs",
+    "nativefs"
   ],
@@ -26,0 +26,0 @@ "files": [

README.md

@@ -1,2 +0,53 @@
-# browser-nativefs
-Native File System API with legacy fallback in the browser
+# Browser-NativeFS
+
+Use the [Native File System API](https://wicg.github.io/native-file-system/)
+with legacy fallback in the browser.
+
+## Usage
+
+```bash
+import {
+  fileOpenPromise,
+  fileSavePromise,
+  imageToBlob
+} from 'https://unpkg.com/browser-nativefs';
+
+(async () => {
+  const fileOpen = (await fileOpenPromise).default;
+  const fileSave = (await fileSavePromise).default;
+
+  const openButton = document.querySelector('#open');
+  const saveButton = document.querySelector('#save');
+
+  openButton.addEventListener('click', async (e) => {
+    try {
+      const blob = await fileOpen({mimeTypes: ['image/*']});
+      const img = document.createElement('img');
+      img.src = URL.createObjectURL(blob);
+      document.body.append(img);
+    } catch (err) {
+      if (err.name !== 'AbortError') {
+        console.error(err);
+      }
+    }
+  });
+
+  saveButton.addEventListener('click', async (e) => {
+    const blob = await imageToBlob(document.querySelector('img'));
+    try {
+      await fileSave(blob, {fileName: 'Untitled.png'});
+    } catch (err) {
+      if (err.name !== 'AbortError') {
+        console.error(err);
+      }
+    }
+  });
+
+  openButton.disabled = false;
+  saveButton.disabled = false;
+})();
+```
+
+## License
+
+Apache 2.0.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16287

increased by8.27%

Number of lines in readme file

54

increased by1700%

No dependency changes