greguz · greguz · Feb 11, 2024 · Nov 28, 2023 · Feb 11, 2024 · Feb 11, 2024
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -15,10 +15,10 @@ jobs:
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 

diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,9 @@
 !.c8rc
 !.editorconfig
 !.github
+!.nojekyll
 coverage
 mutent.cjs
 node_modules
 package-lock.json
+*.tgz
diff --git a/.nojekyll b/.nojekyll
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2023 Giacomo Gregoletto
+Copyright 2024 Giacomo Gregoletto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Mutent
 
 [![npm](https://img.shields.io/npm/v/mutent)](https://www.npmjs.com/package/mutent)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/mutent)
+![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/mutent)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![Actions Status](https://github.com/greguz/mutent/workflows/ci/badge.svg)](https://github.com/greguz/mutent/actions)
 [![Coverage Status](https://coveralls.io/repos/github/greguz/mutent/badge.svg?branch=master)](https://coveralls.io/github/greguz/mutent?branch=master)
@@ -28,7 +28,7 @@ npm install --save mutent
 
 ## Documentation
 
-Start from the [Quickstart](./docs//quickstart.md) section.
+Start from the [Quickstart](https://greguz.github.io/mutent/) section.
 
 ## Example
 

diff --git a/docs/ecosystem.md b/docs/ecosystem.md
@@ -5,7 +5,8 @@
 - [`mutent-array`](https://github.com/greguz/mutent-array) Simple in memory array adapter.
 - [`mutent-json-schema`](https://github.com/greguz/mutent-json-schema) JSON Schema validation plugin with [Ajv](https://github.com/ajv-validator/ajv).
 - [`mutent-migration`](https://github.com/greguz/mutent-migration) Data versioning and migration for Mutent.
-- [`mutent-mongodb`](https://github.com/greguz/mutent-mongodb) MongoDB database adapter.
+- [`mutent-mongodb`](https://github.com/greguz/mutent-mongodb) MongoDB adapter for Mutent.
+- [`mutent-couchdb`](https://github.com/greguz/mutent-couchdb) CouchDB adapter for Mutent.
 
 <!--
 ## Community

diff --git a/docsify/sidebar.md b/docsify/sidebar.md
@@ -0,0 +1,18 @@
+- Getting started
+
+  - [Quickstart](docs/quickstart.md)
+
+- Guide
+
+  - [Store](docs/store.md)
+  - [Adapter](docs/adapter.md)
+  - [Entity](docs/entity.md)
+  - [Mutation](docs/mutation.md)
+  - [Mutator](docs/mutator.md)
+  - [Context](docs/context.md)
+  - [Hooks](docs/hooks.md)
+  - [Errors](docs/errors.md)
+  - [Ecosystem](docs/ecosystem.md)
+
+- [GitHub](https://github.com/greguz/mutent)
+- [NPM](https://www.npmjs.com/package/mutent)
diff --git a/index.html b/index.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Mutent</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="An agnostic solution to work with any Datastore">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'Mutent',
+      repo: 'https://github.com/greguz/mutent',
+      loadSidebar: 'docsify/sidebar.md'
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>
diff --git a/package.json b/package.json
@@ -11,9 +11,8 @@
   "main": "./mutent.cjs",
   "types": "./mutent.d.ts",
   "files": [
-    "docs",
-    "!**/*.spec.mjs",
     "lib",
+    "!**/*.spec.mjs",
     "mutent.mjs",
     "mutent.cjs",
     "mutent.d.ts"
@@ -30,6 +29,7 @@
     "stream"
   ],
   "scripts": {
+    "docsify": "docsify serve .",
     "lint": "standard",
     "test": "c8 ava",
     "build": "rollup -c",
@@ -38,16 +38,17 @@
   "author": "Giacomo Gregoletto",
   "license": "MIT",
   "devDependencies": {
-    "ava": "^5.3.0",
-    "c8": "^7.14.0",
-    "rollup": "^3.25.1",
+    "ava": "^6.1.1",
+    "c8": "^9.1.0",
+    "docsify-cli": "^4.4.4",
+    "rollup": "^4.10.0",
     "standard": "^17.1.0"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/greguz/mutent.git"
   },
-  "homepage": "https://github.com/greguz/mutent#readme",
+  "homepage": "https://greguz.github.io/mutent/",
   "bugs": {
     "url": "https://github.com/greguz/mutent/issues"
   }