Feature/muhammara recipe

.gitignore

@@ -2,10 +2,12 @@ muhammarajs
 build
 .DS_Store
 tests/output
+tests/**/output
 binding
 node_modules
 aws.json
 etc
+recipe-docs/
 
 #all the binaries
 # Compiled source #

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Pre builts for arm64 / musl architecture (M1 using alpine)
+- Hummus-recipe / Muhammara-recipe as part of this lib
 
 ### Fixed
 

README.md

@@ -3,19 +3,28 @@
 [![NPM version](http://img.shields.io/npm/v/muhammara.svg?style=flat)](https://www.npmjs.org/package/muhammara)
 [![Build status](https://github.com/julianhille/MuhammaraJS/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/julianhille/MuhammaraJS/actions/workflows/build.yml)
 
+Welcome to MuhammaraJS.
+A Fast NodeJS Module for Creating, Parsing an Manipulating PDF Files and Streams.
+
+Original Project (CPP base version)
+Project site is [here](http://www.pdfhummus.com).
+
+If you are looking for a C++ Library go [here](https://github.com/galkahana/PDF-Writer).
+
+## Hummus JS is the base
+
 This is a drop in replacement for hummusJS originally made by Galkahana.
 He did an awesome job, but discontinued hummusjs.
 
 The documentation for MuhammaraJS / HummusJS is still located at the
 hummusJS github wiki: available [here](https://github.com/galkahana/HummusJS/wiki)
 
-Welcome to HummusJS.
-A Fast NodeJS Module for Creating, Parsing an Manipulating PDF Files and Streams.
+## muhammara-recipe '(formerly known as hummus-recipe) as been added
 
-Original Project
-Project site is [here](http://www.pdfhummus.com).
+Muhammara-recipe and hummus-recipe has been integrated, dependencies updated
+and is now shipped along with muhammara itself.
 
-If you are looking for a C++ Library go [here](https://github.com/galkahana/PDF-Writer).
+It serves as a drop in replacement.
 
 # Caution
 
@@ -36,7 +45,7 @@ npm install muhammara
 
 ```
 
-# Replace hummusJS with MuhammaraJS
+# Replace hummusJS with MuhammaraJS for hummus
 
 Replace:
 
@@ -50,6 +59,26 @@ With:
 let muhammara = require('muhammara')
 ```
 
+# Replace hummus-recipe or muhammara-recipe with MuhammaraJS
+
+Replace:
+
+`const HummusRecipe = require('hummus-recipe');`
+
+With:
+
+```
+const HummusRecipe = require('muhammara').Receipe;
+```
+
 # Documentation
 
+## Muhammara
+
 You can find samples and documentation [here](./docs/Home.md)
+
+### Muhammara Recipe:
+
+To generate the documentation you could clone this repo and execute:
+
+`npm run recipe-jsdoc`

docs/Custom-streams.md

@@ -17,7 +17,7 @@ The `write` function should write the byte in the input array of bytes. It shoul
 
 The `getCurrentPosition()` function should return the current writing position. If you've been good kids, it's ok to simply sum up the number of bytes written from all the `write` calls so far, and you should be fine.
 
-To see an example implementation see what i did for the response stream [here](../PDFStreamForResponse.js).
+To see an example implementation see what i did for the response stream [here](../lib/PDFStreamForResponse.js).
 
 # Reading streams
 

jsdoc.conf

@@ -0,0 +1,24 @@
+{
+    "tags": {
+        "allowUnknownTags": false
+    },
+    "source": {
+        "include": "./lib/",
+        "includePattern": "(Recipe\\.js)|(recipe/.*\\.js)$",
+        "excludePattern": "(node_modules/|docs)"
+    },
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "opts": {
+        "template": "node_modules/docdash",
+        "encoding": "utf8",
+        "destination": "recipe-docs/",
+        "recurse": true,
+        "verbose": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}