nhb-toolbox 4.14.1 → 4.14.2

package/README.md

@@ -57,7 +57,18 @@
 
 ---
 
-## Install
+## Installation
+
+`nhb-toolbox` is published to two package registries:
+
+- **NPM Registry** (default public registry)
+- **GitHub Packages** (GitHub’s package registry, scoped package)
+
+---
+
+### Installing from NPM Registry (default)
+
+This is the simplest way to install and requires no additional setup.
 
 Choose your preferred package manager:
 
@@ -73,6 +84,109 @@ pnpm add nhb-toolbox
 yarn add nhb-toolbox
 ```
 
+> Use this if you want the stable public version without extra config.
+
+---
+
+<details>
+
+  <summary>
+
+### Installing from GitHub Packages
+
+  </summary>
+  
+GitHub Packages requires authentication and scoped package names.
+
+#### Step 1: Authenticate with GitHub Packages
+
+Create or use a **GitHub Personal Access Token (PAT)** with `read:packages` permission.
+
+Add the following to your project’s `.npmrc` file (create if it doesn’t exist):
+
+```ini
+@nazmul-nhb:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
+```
+
+> Replace `YOUR_GITHUB_PERSONAL_ACCESS_TOKEN` with your actual token.
+
+#### Step 2: Install the package with scoped name
+
+Choose your preferred package manager:
+
+```shell
+npm i @nazmul-nhb/nhb-toolbox
+```
+
+```shell
+pnpm add @nazmul-nhb/nhb-toolbox
+```
+
+```shell
+yarn add @nazmul-nhb/nhb-toolbox
+```
+
+---
+
+#### Where do consumers get the GitHub token?
+
+- **The token is personal and private** — *each consumer must create own*.
+
+- Your **GitHub Personal Access Token (PAT)** **should never be shared publicly or with consumers**.
+
+---
+
+#### How consumers create own token
+
+1. **Go to GitHub account settings** → **Developer settings** → **Personal access tokens** → **Tokens (classic)**.
+
+2. Click **Generate new token**, then:
+
+   - Give it a name (e.g., `npm package read access`).
+
+   - Set expiration as prefer.
+
+   - **Enable only the `read:packages` permission** (to allow reading packages).
+
+3. Generate the token and **copy it immediately** — won't see it again.
+
+---
+
+#### What should consumers do with the token?
+
+- Add it to `.npmrc` file (or environment) to authenticate with GitHub Packages.
+
+Example `.npmrc` snippet:
+
+```ini
+@nazmul-nhb:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=PERSONAL_ACCESS_TOKEN_HERE
+```
+
+</details>
+
+---
+
+### Summary
+
+| Registry        | Package Name              | Registry URL                                             | Requires Auth?                 |
+| --------------- | ------------------------- | -------------------------------------------------------- | ------------------------------ |
+| NPM Registry       | `nhb-toolbox`             | [https://registry.npmjs.org](https://registry.npmjs.org) | No                             |
+| GitHub Packages | `@nazmul-nhb/nhb-toolbox` | [https://npm.pkg.github.com](https://npm.pkg.github.com) | Yes (PAT with `read:packages`) |
+
+---
+
+If you want to use both, just configure `.npmrc` accordingly and install the appropriate package name depending on your needs.
+
+---
+
+### Notes
+
+- The GitHub Packages version may include pre-release or private builds.
+- NPM Registry version is the recommended default for most users.
+- You can safely use either registry depending on your environment.
+
 ---
 
 ## Changelog

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.14.1",
+  "version": "4.14.2",
   "description": "A versatile collection of smart, efficient, and reusable utility functions and classes for everyday development needs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",