npmPublish changes

Author: abose

.gitignore

@@ -8,3 +8,4 @@ node_modules
 dist/*
 !dist/virtualfs.js
 !dist/virtualfs.js.map
+phoenix-fs-*.tgz

README.md

@@ -3,6 +3,31 @@
 node like `fs` API for the browser that uses indexedDB/ fs access browser APIs for persistence.
 
 ## Installation
+### Usage in browser
+Put the below script tag in your html file. A Global `fs` object
+will be created with the necessary fs APIs. 
+* The fs apis have compatibility with nodejs like fs APIs.
+See filer docs for API docs: https://filer.js.org/
+
+```js
+<script src="path/to/dist/virtualfs.js"/>
+```
+
+### Usage in web-worker in browser
+Inside your web-worker, import the library as below. There are some limitations for 
+web workers with native fs mount points to keep in mind:
+1. Native fs aceess based APIs are only available in chrome. This is a platform limitation and firefox have not
+started supporting the API yet.
+2. Use fs.mountNativeFolder to mount a local directory.
+3. After mounting, access the files using the mountPath returned
+```js
+importScripts('path/to/dist/virtualfs.js');
+fs.mountNativeFolder((err, mountPathArray)=>{
+    console.log(err, mountPathArray);
+});
+```
+
+## Development
 
 To build it:
 
@@ -24,7 +49,3 @@ npm run test
 The js library will be built in `dist/nohost-sw.js`. 
 NOTE: you can also use `npm run dev` to also start a web server for development.
 
-
-```js
-<script src="path/to/dist/virtualfs.js"/>
-```

package.json

@@ -31,8 +31,8 @@
     "url": "https://github.com/phcode-dev/phoenix-fs"
   },
   "files": [
-    "dist/fslib.js",
-    "dist/fslib.js.map"
+    "dist/virtualfs.js",
+    "dist/virtualfs.js.map"
   ],
   "devDependencies": {
     "browser-mime": "1.0.1",