@authress/sdk - npm Package Compare versions

Comparing version 3.0.172 to 3.0.173

package.json

 {
   "name": "@authress/sdk",
-  "version": "3.0.172",
+  "version": "3.0.173",
   "description": "Client SDK for Authress authorization as a service. Provides managed authorization api to secure service resources including user data.",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -9,3 +9,4 @@ <p align="center">
     <a href="https://www.npmjs.com/package/@authress/sdk" alt="Authress SDK on npm"><img src="https://badge.fury.io/js/@authress%2Fsdk.svg"></a>
-    <a href="./LICENSE" alt="Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+    <a href="https://github.com/Authress/authress-sdk.js/actions/workflows/build.yml" alt="Build status"><img src="https://github.com/Authress/authress-sdk.js/actions/workflows/build.yml/badge.svg"></a>
+    <a href="https://github.com/Authress/authress-sdk.js/blob/main/LICENSE" alt="Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
     <a href="https://authress.io/community" alt="authress community"><img src="https://img.shields.io/badge/Community-Authress-fbaf0b.svg"></a>
@@ -25,3 +26,3 @@ </p>
 ```js
-const { AuthressClient } = require('@authress/sdk');
+import { AuthressClient } from '@authress/sdk';
 ```
@@ -31,2 +32,20 @@
 
+### Reference Guide
+
+See the SDK reference guide for a examples of commonly executed blocks with descriptions.
+
+<!-- Use absolute links, to support this link working from PackageManager-->
+[SDK Documentation](https://github.com/Authress/authress-sdk.js/blob/main/docs/README.md)
+
+
+### Method Documentation
+
+<!-- Use absolute links, to support this link working from PackageManager-->
+[Authorize using a user token](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#authorize-using-a-user-token)
+[Authorize with a service client](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#authorize-with-a-service-client)
+[Creating resources](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#creating-resources)
+[Verifying a token using the token verifier](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#verifying-a-token-using-the-token-verifier)
+[Make direct API requests](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#make-direct-api-requests)
+[Paginating through a collection resource](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#paginating-through-a-collection-resource)
+
 ### Frequently Asked Questions
@@ -37,6 +56,2 @@ * Where do I get a user ID from?
 
-### Method Documentation
-
-[SDK examples](./docs/methods.md)
-
 ### Framework Examples
@@ -50,7 +65,4 @@ See all the available [Authress Starter Kits](https://github.com/search?q=org%3AAuthress+starter-kit&type=repositories)
 
-### Adding new DTO and methods
-Auto generate the new code using this openapi generator, and merge the files into the appropriate locations:
-```bash
-curl -XPOST https://generator3.swagger.io/api/generate -H 'content-type: application/json' -d '{"specURL" : "https://api.authress.io/.well-known/openapi.json","lang" : "typescript-fetch","type" : "CLIENT","codegenVersion" : "V3"}'  --output generated_sdk.tar.gz
+<!-- Use absolute links, to support this link working from PackageManager-->
 
-```
+[Developing for the Javascript SDK](https://github.com/Authress/authress-sdk.js/blob/main/contributing.md)

No alert changes

Improved metrics

Total package byte prevSize

124375

0.94%

Number of lines in readme file

64

23.08%

No dependency changes