NFS-1239: Readme templates updated

Staffbase · Jan 21, 2021 · 44042de · 44042de
1 parent 6016a5d
commit 44042de
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 19 deletions.
diff --git a/docSrc/mainFile.tpl b/docSrc/mainFile.tpl
@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/Staffbase/plugins-sdk-nodejs.svg?branch=master)](https://travis-ci.org/Staffbase/plugins-sdk-nodejs)
+
 # Staffbase Plugins SDK for Node.js.
 
 {{{overview}}}

diff --git a/docSrc/sections/license.tpl b/docSrc/sections/license.tpl
@@ -1,3 +1,3 @@
-Copyright 2017 Staffbase GmbH.
+Copyright 2017-2021 Staffbase GmbH.
 
 Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
diff --git a/docSrc/sections/overview.tpl b/docSrc/sections/overview.tpl
@@ -1 +1 @@
-If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/api/plugin-sso/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.
+If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/guide/customplugin-overview/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.
diff --git a/docs/API.MD b/docs/API.MD
@@ -1,20 +1,4 @@
 
-## Classes
-Global | Description
------- | -----------
-SSOToken | SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
-SSOTokenData : SSOTokenData | SSOTokenData Class used to host the token data values and provide getter functions to extract correspinding values.
-
-## Functions
-Global | Description
------- | -----------
-ssoMiddleWare(secret, audience) ⇒ function | Mountable express middleware functions
-readKeyFile(path, cb) ⇒ String | Reads public key file from the specified path and returns a string representation
-of the key to be used to decode token.
-asCert(cert, type) ⇒ string | asCert converts a binary encoded key to PKCS8 format
-isPKCS8Format(key, type) ⇒ Boolean | Checks if the format of the key is similar to PKCS8 Format.
-transformKeyToFormat(key, type) ⇒ String | Transforms the provided key to PKCS8 format for supported jwt algorithm.
-
 ## SSOToken
 SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@staffbase/staffbase-plugin-sdk",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Staffbase Plugin SDK for Javascript / Node.js",
   "main": "./dist/index.js",
   "scripts": {
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/api/plugin-sso/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.
		If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/guide/customplugin-overview/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.