Skip to content

Commit 44042de

Browse files
NFS-1239: Readme templates updated
1 parent 6016a5d commit 44042de

File tree

5 files changed

+5
-19
lines changed

5 files changed

+5
-19
lines changed

docSrc/mainFile.tpl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Build Status](https://travis-ci.org/Staffbase/plugins-sdk-nodejs.svg?branch=master)](https://travis-ci.org/Staffbase/plugins-sdk-nodejs)
2+
13
# Staffbase Plugins SDK for Node.js.
24

35
{{{overview}}}

docSrc/sections/license.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Copyright 2017 Staffbase GmbH.
1+
Copyright 2017-2021 Staffbase GmbH.
22

33
Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

docSrc/sections/overview.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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.
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/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.

docs/API.MD

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,4 @@
11

2-
## Classes
3-
Global | Description
4-
------ | -----------
5-
SSOToken | SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
6-
SSOTokenData : SSOTokenData | SSOTokenData Class used to host the token data values and provide getter functions to extract correspinding values.
7-
8-
## Functions
9-
Global | Description
10-
------ | -----------
11-
ssoMiddleWare(secret, audience) ⇒ function | Mountable express middleware functions
12-
readKeyFile(path, cb) ⇒ String | Reads public key file from the specified path and returns a string representation
13-
of the key to be used to decode token.
14-
asCert(cert, type) ⇒ string | asCert converts a binary encoded key to PKCS8 format
15-
isPKCS8Format(key, type) ⇒ Boolean | Checks if the format of the key is similar to PKCS8 Format.
16-
transformKeyToFormat(key, type) ⇒ String | Transforms the provided key to PKCS8 format for supported jwt algorithm.
17-
182
## SSOToken
193
SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
204

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@staffbase/staffbase-plugin-sdk",
3-
"version": "1.1.1",
3+
"version": "1.1.2",
44
"description": "Staffbase Plugin SDK for Javascript / Node.js",
55
"main": "./dist/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)