Merge branch 'main' of github.com:mblink/fp-ts-indexeddb into test-br…

…anch

.eslintrc.js

@@ -3,6 +3,7 @@ module.exports = {
     es6: true,
     node: true,
     jest: true,
+    jasmine: true,
   },
   extends: [
     "eslint:recommended",

README.md

@@ -1 +1,15 @@
-# fp-ts-indexeddb
+# fp-ts-indexeddb
+
+**fp-ts-indexeddb is a simple functional wrapper around the underlying IndexedDB API utilizing FP-TS.**
+
+The API of fp-ts-indexeddb tries its best to respect the naming convention of the underlying IndexedDB
+and only deviating where necessary to avoid reserved words like `delete`.
+
+## API Methods:
+* open
+* insert
+* put
+* get
+* getAll
+* remove
+* clearStore

jest.config.js

@@ -1,4 +1,8 @@
 module.exports = {
   preset: 'ts-jest',
-  testEnvironment: 'node',
+  testEnvironment: 'jsdom',
+  testRunner: "jest-jasmine2",
+  setupFiles: [
+    "fake-indexeddb/auto"
+  ],
 };