ci: set script name (#14)

* fix: ignore tsconfig in npm

* docs: `README`, functions.md

* docs: mark JSDoc internal and private

* docs(README): absolute link for functions.md

* ci: add script name

* docs(README): formatting

* ci(name): set line-break

* ci(name): remove duplicate

* docs(README): format imports

Author: azan-n

.github/workflows/release.yml

@@ -1,8 +1,10 @@
+name: Build @cryptlex/web-api-client
+
 on:
   push:
     branches:
       - main
-name: release-please
+
 jobs:
   release-please:
     runs-on: ubuntu-latest

README.md

@@ -19,29 +19,18 @@ npm install @cryptlex/web-api-client
 The library needs to be configured with the a valid access token. This is done in the `CryptlexWebApiClientOptions` instantiation.
 
 ```ts
-import {
-  CryptlexWebApiClient,
-  CryptlexWebApiClientOptions,
-} from "@cryptlex/web-api-client";
+import { CryptlexWebApiClient, CryptlexWebApiClientOptions } from "@cryptlex/web-api-client";
 
 const ACCESS_TOKEN = "**ACCESS_TOKEN**";
 const PRODUCT_ID = "**PRODUCT_ID**";
 
-const cryptlexWebApiClientOptions = new CryptlexWebApiClientOptions(
-  ACCESS_TOKEN
-);
-const cryptlexWebApiClient = new CryptlexWebApiClient(
-  cryptlexWebApiClientOptions
-);
+const clientOptions = new CryptlexWebApiClientOptions(ACCESS_TOKEN);
+const client = new CryptlexWebApiClient(clientOptions);
 
 try {
   // Create a license in the product defined by PRODUCT_ID
-  const licenseResponse = await cryptlexWebApiClient.createLicense({
-    productId: PRODUCT_ID,
-  });
-  console.log(
-    "\nSuccessfully created license: " + JSON.stringify(licenseResponse.data)
-  );
+  const licenseResponse = await client.createLicense({ productId: PRODUCT_ID });
+  console.log("Successfully created license: " + JSON.stringify(licenseResponse.data));
 } catch (error) {
   console.error(error);
 }