@ocfl/ocfl-fs 0.1.2 → 0.2.0

package/README.md

@@ -1,4 +1,22 @@
-# ocfl-js - Filesystem storage implementation
+# ocfl-fs - OCFL implementation using Filesystem storage backend for Node.js
 This is JavaScript/Node.js library to create and interact with Oxford Common File Layout (OCFL) storage and objects within it. 
 This package implements the OCFL client that stores storage root and its objects on a locally attached filesystem.
 
+## Installation
+
+    npm install @ocfl/ocfl-fs
+
+## Usage
+
+The storage and object methods accept an optional fs parameter, which can be any module that implements Node.js fs module API. By default, it will use the built in fs module.
+
+    const ocfl = require('@ocfl/ocfl-fs');
+    const storage = ocfl.storage({root: '/var/data/myocfl'});
+
+For example, by passing it memfs (https://www.npmjs.com/package/memfs) the OCFL storage will be created in memory using the memfs module: 
+
+    const ocfl = require('@ocfl/ocfl-fs');
+    const fs = require('memfs');
+    const storage = ocfl.storage({root: '/var/data/myocfl'}, {fs});
+
+For common usage documentation please refer to the [README.md in GitHub](https://github.com/Arkisto-Platform/ocfl-js)

package/lib/store.js

@@ -18,11 +18,6 @@ class OcflFsStore extends OcflStore {
   /** @type {Map<Object, OcflFsStore>} */
   static instances = new Map();
 
-  /**
-   * 
-   * @param {Object} options 
-   * @param {typeof fs} [options.fs]
-   */
   // static getInstance({fs = require('fs')} = {}) {
   //   let store = OcflFsStore.instances.get(fs);
   //   if (!store) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocfl/ocfl-fs",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Oxford Common File Layout (OCFL) JS client library for filesystem storage",
   "main": "index.js",
   "exports": {
@@ -41,10 +41,14 @@
     "jsdoc": "^3.6.10",
     "mocha": "^10.0.0",
     "typedoc": "^0.22.15",
-    "@ocfl/ocfl-tests": "0.1.*"
+    "@ocfl/ocfl-tests": "*"
   },
   "dependencies": {
-    "@ocfl/ocfl": "0.1.1"
+    "@ocfl/ocfl": "0.2.0"
   },
-  "files": [ "index.js", "index.mjs", "lib" ]
+  "files": [
+    "index.js",
+    "index.mjs",
+    "lib"
+  ]
 }