doc: enhance readme

Staffbase · Dec 1, 2023 · 40a5b6d · 40a5b6d
1 parent dfe0f92
commit 40a5b6d
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 14 deletions.
diff --git a/README.MD b/README.MD
@@ -186,16 +186,17 @@ Copyright 2017-2023 Staffbase GmbH.
 
 Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0
 
+
 <table>
-  <tr>
-    <td>
-      <img src="docs/assets/images/staffbase.png" alt="Staffbase GmbH" width="96" />
-    </td>
-    <td>
-      <b>Staffbase GmbH</b>
-      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
-      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
-    </td>
-  </tr>
-</table>
+      <tr>
+        <td>
+          <img src="docs/assets/images/staffbase.png" alt="Staffbase GmbH" width="96" />
+        </td>
+        <td>
+          <b>Staffbase GmbH</b>
+          <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
+          <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
+        </td>
+      </tr>
+    </table>
 
diff --git a/docSrc/buildDoc.js b/docSrc/buildDoc.js
@@ -30,6 +30,7 @@ jsdoc2md.render({
       const contributionText = retArr[4];
       const testText = retArr[5];
       const licenseText = retArr[6];
+      const footerText = retArr[7];
 
       return new Promise( (resolve, reject) => {
         fs.readFile(path.join(__dirname, './mainFile.tpl'), (err, mainTpl) => {
@@ -45,6 +46,7 @@ jsdoc2md.render({
               contribution: contributionText,
               tests: testText,
               license: licenseText,
+              footer: footerText,
             });
             // Copy generated markdown file to root folder
             fs.writeFile(path.join(__dirname, '../README.MD'), rendered, (err, done) => {

diff --git a/docSrc/mainFile.tpl b/docSrc/mainFile.tpl
@@ -27,3 +27,5 @@
 ## License
 
 {{{license}}}
+
+{{{footer}}}
diff --git a/docSrc/sections/footer.tpl b/docSrc/sections/footer.tpl
@@ -0,0 +1,12 @@
+<table>
+      <tr>
+        <td>
+          <img src="docs/assets/images/staffbase.png" alt="Staffbase GmbH" width="96" />
+        </td>
+        <td>
+          <b>Staffbase GmbH</b>
+          <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
+          <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
+        </td>
+      </tr>
+    </table>
diff --git a/docSrc/sections/index.js b/docSrc/sections/index.js
@@ -104,6 +104,19 @@ module.exports = {
         }
       });
     });
+    const footerPromise = new Promise( (resolve, reject) => {
+      fs.readFile(path.join(__dirname, 'footer.tpl'), (err, footerTpl) => {
+        if (err) {
+          reject(err);
+        } else {
+          const tpl = handlebars.compile(footerTpl.toString());
+          const rendered = tpl({
+
+          });
+          resolve(rendered);
+        }
+      });
+    });
     return Promise.all([
       overviewPromise,
       installationPromise,
@@ -112,6 +125,7 @@ module.exports = {
       contributionPromise,
       testPromise,
       licensePromise,
+      footerPromise,
     ]);
   },
 };
diff --git a/docSrc/sections/license.tpl b/docSrc/sections/license.tpl
@@ -1,3 +1,3 @@
-Copyright 2017-2021 Staffbase GmbH.
+Copyright 2017-2023 Staffbase GmbH.
 
 Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0
diff --git a/docSrc/sections/usage.tpl b/docSrc/sections/usage.tpl
@@ -54,6 +54,8 @@ The following data can be retrieved from the token:
 
 |Helper Name|Token Key| Fetch Function| Description|
 | --- | --- | --- | --- |
+|CLAIM_BRANCH_ID|branch_id|getBranchId()|Get the branch ID for which the token was issued.|
+|CLAIM_BRANCH_SLUG|branch_slug|getBranchSlug()|Get the branch slug for which the token was issued.|
 |CLAIM_AUDIENCE|aud|getAudience()|Get targeted audience of the token.|
 |CLAIM_EXPIRE_AT|exp|getExpireAtTime()|Get the time when the token expires.|
 |CLAIM_NOT_BEFORE|nbf|getNotBeforeTime()|Get the time when the token starts to be valid.|

diff --git a/docs/API.MD b/docs/API.MD
@@ -112,7 +112,6 @@ Internally used to get value against the client param string.
 | --- | --- | --- |
 | claimName | String | The claim name as defined in the tokenDataConsts |
 
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)
 ### ssoTokenData.getBranchId() ⇒ null ⎮ string
 Get the branch ID for which the token was issued.
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@staffbase/staffbase-plugin-sdk",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Staffbase Plugin SDK for Javascript / Node.js",
   "main": "./dist/index.js",
   "scripts": {