bkper-js 1.2.1 → 1.2.2

package/README.md

@@ -2,9 +2,16 @@
 
 [![npm](https://img.shields.io/npm/v/bkper?color=%235889e4)](https://www.npmjs.com/package/bkper)
 
-Bkper Node.js client provides a simple and secure way to access the [Bkper REST API] on [Node.js](https://nodejs.dev/)
+bkper-js library is a simple and secure way to access the [Bkper REST API] on Node.js and modern browsers.
 
-## Instalation
+It provides a set of classes and functions to interact with the Bkper API, including authentication, authorization, and data manipulation.
+
+## Documentation
+
+- [Developer Docs](https://bkper.com/docs)
+- [API Reference](https://bkper.com/docs/bkper-js/)
+
+## Installation
 
 ### Add the package:
 
@@ -20,8 +27,4 @@ or
 bun add bkper-js
 ```
 
-## Documentation
-
-- [Developer Docs](https://bkper.com/docs)
-- [API Reference](https://bkper.com/docs/bkper-js/)
 

package/lib/index.d.ts

@@ -369,7 +369,20 @@ export declare class App {
 }
 
 /**
- * This is the main Entry Point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
+ * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
+ *
+ * You start by setting the API [[Config]] object.
+ *
+ * Example:
+ *
+ * ```javascript
+ * Bkper.setConfig({
+ *   apiKeyProvider: () => process.env.BKPER_API_KEY,
+ *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
+ * })
+ * ```
+ *
+ * Once the config is set, you can start using the library.
  *
  * @public
  */

package/lib/model/Bkper.js

@@ -14,7 +14,20 @@ import * as UserService from '../service/user-service.js';
 import { HttpApiRequest } from '../service/http-api-request.js';
 import { User } from "./User.js";
 /**
- * This is the main Entry Point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
+ * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
+ *
+ * You start by setting the API [[Config]] object.
+ *
+ * Example:
+ *
+ * ```javascript
+ * Bkper.setConfig({
+ *   apiKeyProvider: () => process.env.BKPER_API_KEY,
+ *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
+ * })
+ * ```
+ *
+ * Once the config is set, you can start using the library.
  *
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",