feat(documentation): added readme and documentation generation

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 yarn servable:document
+yarn servable:readme

README.md

@@ -1,113 +1,64 @@
-# Publishable Protocol
+# Publishable protocol
+
+
+@publishable, #1.0.0
+
+
+> [!WARNING]
+
+> Servable is still experimental and its api may change in the future.
+
+
+
+![icon](/static/img/polar-bear-4.png "icon")
+
+
 
-![logo](/static/img/polar-bear-4.png)
 
 [![npm Package](https://img.shields.io/npm/v/@servable-community/publishable.svg?style=flat-square)](https://www.npmjs.org/package/@servable-community/publishable)
+
 [![NPM Downloads](https://img.shields.io/npm/dm/@servable-community/publishable.svg)](https://npmjs.org/package/@servable-community/publishable)
+
 [![Build Status](https://github.com/servable-community/publishable/actions/workflows/release.yml/badge.svg)](https://github.com/servable-community/publishable/actions/tests.yml)
+
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-The publishable protocol handles the complete publication state of an object.
-
-## Install
-```bash
-yarn add @servable-community/publishable
-```
-
-## Auxiliary packages
-
-### Shared library
-[@servable-community/publishable-shared](https://github.com/servable-community/publishable-shared)
-```bash
-yarn add @servable-community/publishable-shared
-```
-
-### React library
-[@servable-community/publishable-react](https://github.com/servable-community/publishable-react)
-```bash
-yarn add @servable-community/publishable-react
-```
-
-## Protocol
-### Configuration
-#### Payload sample
-```json
- {
-    "id": "publishable",
-    "name": "publishable",
-    "slug": "ps",
-    "module": {
-        "@servable-community/publishable": "*"
-    },
-    "version": "*",
-    "params": {
-        "liveClasses": ["publishable"],
-        "schema": {
-            "restrictSecurity": true
-        }
-    }
-}
-```
-#### Reference
-
-
-### Capacities
-#### Schema
-**Classes**
-TODO
-
-**Class level permissions**
-TODO
-
-**Indexes**
-```json
-{
-    "_publishableStatus": {
-        "publishableStatus": 1
-    }
-}
-```
-
-**Fields**
-```json
-{
-    "publishableStatus": {
-        "type": "String"
-    }
-}
-```
-
-#### Protocol class
-TODO
-#### Classes
-TODO
-#### Triggers
-TODO
-#### Before init
-TODO
-#### After init
-TODO
-#### Seed
-TODO
-#### Config
-TODO
-#### Functions
-TODO
-#### Jobs
-TODO
-#### Live classes
-TODO
-
-### Security
-TODO
-
-### Performance
-TODO
-
-## Servable Documentation
-You can find here the complete [servable documentation](https://documentation.servable.app/) with guides and api reference.
-
-## License
-
-MIT © [servable-community](https://github.com/servable-community)
+
+
+
+Generated documentation below
+
+
+## A complete lifecycle management for publication
+
+
+
+Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+
+
+
+
+
+## Seed
+
+## Protocol class
+
+## Before init
+
+## After init
+
+## Config
+
+## Functions
+
+## Live Classes
+
+## Schema
+
+## System
+
+## Lib
+
+## Triggers

README_.md

@@ -0,0 +1,113 @@
+# Publishable Protocol
+
+![logo](/static/img/polar-bear-4.png)
+
+[![npm Package](https://img.shields.io/npm/v/@servable-community/publishable.svg?style=flat-square)](https://www.npmjs.org/package/@servable-community/publishable)
+[![NPM Downloads](https://img.shields.io/npm/dm/@servable-community/publishable.svg)](https://npmjs.org/package/@servable-community/publishable)
+[![Build Status](https://github.com/servable-community/publishable/actions/workflows/release.yml/badge.svg)](https://github.com/servable-community/publishable/actions/tests.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+The publishable protocol handles the complete publication state of an object.
+
+## Install
+```bash
+yarn add @servable-community/publishable
+```
+
+## Auxiliary packages
+
+### Shared library
+[@servable-community/publishable-shared](https://github.com/servable-community/publishable-shared)
+```bash
+yarn add @servable-community/publishable-shared
+```
+
+### React library
+[@servable-community/publishable-react](https://github.com/servable-community/publishable-react)
+```bash
+yarn add @servable-community/publishable-react
+```
+
+## Protocol
+### Configuration
+#### Payload sample
+```json
+ {
+    "id": "publishable",
+    "name": "publishable",
+    "slug": "ps",
+    "module": {
+        "@servable-community/publishable": "*"
+    },
+    "version": "*",
+    "params": {
+        "liveClasses": ["publishable"],
+        "schema": {
+            "restrictSecurity": true
+        }
+    }
+}
+```
+#### Reference
+
+
+### Capacities
+#### Schema
+**Classes**
+TODO
+
+**Class level permissions**
+TODO
+
+**Indexes**
+```json
+{
+    "_publishableStatus": {
+        "publishableStatus": 1
+    }
+}
+```
+
+**Fields**
+```json
+{
+    "publishableStatus": {
+        "type": "String"
+    }
+}
+```
+
+#### Protocol class
+TODO
+#### Classes
+TODO
+#### Triggers
+TODO
+#### Before init
+TODO
+#### After init
+TODO
+#### Seed
+TODO
+#### Config
+TODO
+#### Functions
+TODO
+#### Jobs
+TODO
+#### Live classes
+TODO
+
+### Security
+TODO
+
+### Performance
+TODO
+
+## Servable Documentation
+You can find here the complete [servable documentation](https://documentation.servable.app/) with guides and api reference.
+
+## License
+
+MIT © [servable-community](https://github.com/servable-community)

package.json

@@ -38,9 +38,8 @@
     "test:unit": "yarn node --require=dotenv/config --experimental-vm-modules --experimental-specifier-resolution=node $(yarn bin jest) --config ./jest.config.json",
     "test:watch": "react-scripts test --env=jsdom",
     "servable:document": "node -e 'import(\"../../../core/manifest/src/index.js\").then(m => m.documentProtocol({path: (process.cwd() + \"/src\"), write: true}))'",
-    "servable:readme": "node -e 'import(\"../../../core/manifest/src/index.js\").then(m => m.generateGithubReadme({path: (process.cwd() + \"/src\"), write: true}))'",
-    "servable:document_": "node -e 'import(\"./node_modules/servable-manifest/src/index.js\").then(m => m.documentProtocol({path: (process.cwd() + \"/src\"), write: true}))'",
-    "prepare": "husky install"
+    "servable:readme": "node -e 'import(\"./node_modules/servable-manifest/src/index.js\").then(m => m.generateGithubReadme({path: (process.cwd() + \"/src\"), write: true, targetPath: (process.cwd() + \"/README.md\" )}))'",
+    "servable:document_": "node -e 'import(\"./node_modules/servable-manifest/src/index.js\").then(m => m.documentProtocol({path: (process.cwd() + \"/src\"), write: true}))'"
   },
   "repository": {
     "type": "git",
@@ -96,7 +95,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.4",
     "semantic-release": "^22.0.5",
-    "servable-manifest": "^1.9.0",
+    "servable-manifest": "^1.11.0",
     "size-limit": "^4.10.2"
   }
 }

src/documentation/generated/afterInit.md

@@ -0,0 +1 @@
+# After init

src/documentation/generated/beforeInit.md

@@ -0,0 +1 @@
+# Before init

src/documentation/generated/class.md

@@ -0,0 +1 @@
+# Protocol class

src/documentation/generated/config.md

@@ -0,0 +1 @@
+# Config

src/documentation/generated/functions.md

@@ -0,0 +1 @@
+# Functions

src/documentation/generated/index.md

@@ -0,0 +1,24 @@
+
+
+
+## Seed
+
+## Protocol class
+
+## Before init
+
+## After init
+
+## Config
+
+## Functions
+
+## Live Classes
+
+## Schema
+
+## System
+
+## Lib
+
+## Triggers

src/documentation/generated/lib.md

@@ -0,0 +1 @@
+# Lib

src/documentation/generated/liveClasses.md

@@ -0,0 +1 @@
+# Live Classes

src/documentation/generated/schema.md

@@ -0,0 +1 @@
+# Schema

src/documentation/generated/seed.md

@@ -0,0 +1 @@
+# Seed

src/documentation/generated/system.md

@@ -0,0 +1 @@
+# System

src/documentation/generated/triggers.md

@@ -0,0 +1 @@
+# Triggers