chore: readme

Author: Novout

README.md

@@ -10,7 +10,6 @@ Client/Server Side PDF-Generator based in PDFKit
 <h4>
 <br>
 <p align="center">
-  <a><img src="https://img.shields.io/github/workflow/status/Novout/pdfeasy/Tests?style=for-the-badge&color=5cb4f8&"></a>
   <a><img src="https://img.shields.io/github/license/Novout/pdfeasy?style=for-the-badge&color=5cb4f8&label="></a>
 <p>
 
@@ -26,26 +25,12 @@ Client/Server Side PDF-Generator based in PDFKit
 
 ## Installation
 
-It's simple!
-
 ### NPM
 
 ```shell
 npm i pdfeasy
 ```
 
-### YARN
-
-```shell
-yarn add pdfeasy
-```
-
-### PNPM
-
-```shell
-pnpm add pdfeasy
-```
-
 ## Simple Example
 
 ```ts
@@ -62,47 +47,105 @@ pdfeasy.new({
       left: 80,
       right: 80
     }
-  },
-  plugins: [ // Plugins!
-    {
-      page: [ // render callback in every page AFTER finish contents insert. Not support before at this time.
-        // simple counter footer
-        ({ Text, Image }, context, current, total) => {
-          // render in every page
-          Text(`${current}/${total}`, { fontSize: 20 }, {
-            x: context.width / 2,
-            y: context.height - context.margins.bottom
-          })
-
-          // Image('https://i.imgur.com/to/path.png', {}, {})
-        },
-        // simple header
-        ({ Text }, context, current, total) => {
-          // render in every page
-          Text('A Simple Header', {}, {
-            x: context.width / 2,
-            // negative number (-30 in case) ignore default margins
-            y: context.margins.top - 20
-          })
-        }
-      ]
-    }
-  ]
+  }
 })
 
+pdfeasy.add([
+  { raw: 'Simple text!' },
+])
+
+pdfeasy.run({
+  type: 'client',
+  clientEmit: 'blob'
+}).then((blob: string) => {
+  const iframe = document.querySelector('#pdf') as HTMLIFrameElement
+
+  iframe.src = blob
+}).catch((err: any) => {
+  console.error(err)
+})
+```
+
+## Content
+
+```ts
 pdfeasy.add([
   ...Utils.content(), // Utils for debug
-  { raw: 'Hello PDFEasy!', text: { font: 'Roboto' }}, // custom font,
+  { raw: 'Hello PDFEasy!', text: { font: 'Roboto' }}, // text with custom font,
   { raw: 'https://i.imgur.com/path.png', image: {}}, // external image
   { stack: [ // stack for paragraph's
     { raw: 'A ', text: {}},
     { raw: 'Simple', text: { bold: true, italic: true }},
     { raw: ' Stack!', text: {}},
   ]},
-  // not recommended use this
-  { raw: 'Text without option!' },
 ])
+```
+
+## Plugins
 
+```ts
+pdfeasy.new({
+  plugins: [{
+    cover: 'https://i.imgur.com/path.png', // cover image (it's ignore default explicit margins insert)
+    background: (page) => { // render custom background in pages
+      return 'https://i.imgur.com/path.png'
+    },
+    onBefore: () => {
+      // before contents transform
+    },
+    onAfter: () => {
+      // after contents transform
+    },
+    page: [ // render callback in every page AFTER finish contents insert. Not support before at this time.
+      // simple counter footer
+      ({ Text, Image }, context, current, total) => {
+        // render in every page
+        Text(`${current}/${total}`, { fontSize: 20 }, {
+          x: context.width / 2,
+          y: context.height - context.margins.bottom
+        })
+
+        // Image('https://i.imgur.com/to/path.png', {}, {})
+      },
+      // simple header
+      ({ Text }, context, current, total) => {
+        // render in every page
+        Text('A Simple Header', {}, {
+          x: context.width / 2,
+          // negative number (-20 in case) ignore default pdfkit margins
+          y: context.margins.top - 20
+        })
+      }
+    ]
+  }]
+})
+```
+
+> Plugins runs as a queue.
+
+## Runner Options
+
+```ts
+pdfeasy.run({
+  type: 'client',
+  clientEmit: 'save'
+}).then(() => {}).catch((err: any) => {
+  console.error(err)
+})
+```
+
+```ts
+pdfeasy.run({
+  type: 'server',
+  serverPath: path.resolve(process.cwd() + '/examples')
+}).then(() => {}).catch((err: any) => {
+  console.error(err)
+})
+```
+
+## Custom Fonts
+
+```ts
 // or https://path/to/Roboto.ttf
 pdfeasy.addFonts([
   {
@@ -113,15 +156,11 @@ pdfeasy.addFonts([
     bolditalic: 'fonts/Roboto-BoldItalic.ttf'
   }
 ])
+```
 
-pdfeasy.run().then((blob: string) => {
-  const iframe = document.querySelector('#pdf') as HTMLIFrameElement
+> **Attention!** Client-Side version not support relative/absolute font paths at this time.
 
-  iframe.src = blob
-}).catch((err: any) => {
-  console.error(err)
-})
-```
+## Resources
 
 See [source demo](./demo) for more explanations
 
@@ -131,7 +170,7 @@ See [scripts](./scripts/generate/) for server-side runner.
 
 ## Bundles
 
-> Uses standard minification
+> **Attention!** Its recommended use explicit imports (*import pdfeasy from 'pdfeasy/dist/client.esm.js'*) in your projects.
 
 `pdfeasy/dist/client.cjs.js`
 
@@ -142,5 +181,3 @@ See [scripts](./scripts/generate/) for server-side runner.
 `pdfeasy/dist/node.esm.js`
 
 `pdfeasy/dist/node.iife.js`
-
-`pdfeasy/dist/index.d.ts`