release 19.0.0

Author: GODrums

PUBLISH.md

@@ -0,0 +1,66 @@
+# Publishing to GitHub Package Registry
+
+This guide explains how to publish the `ngx-angular-query-builder` library to GitHub Package Registry.
+
+## Prerequisites
+
+1. **GitHub Repository**: Ensure your code is pushed to a GitHub repository
+2. **GitHub Personal Access Token**: Create a token with `write:packages` scope
+3. **Updated Configuration**: Make sure all configuration files are properly set up
+
+## Local Publishing (Manual)
+
+If you want to publish manually:
+
+1. **Build the library:**
+   ```bash
+   npm run build-package
+   ```
+
+2. **Navigate to the dist folder:**
+   ```bash
+   cd dist/ngx-angular-query-builder
+   ```
+
+3. **Login to GitHub Package Registry:**
+   ```bash
+   npm login --registry=https://npm.pkg.github.com
+   ```
+   - Username: Your GitHub username (lowercase)
+   - Password: Your GitHub Personal Access Token (classic)
+
+4. **Publish:**
+   ```bash
+   npm publish
+   ```
+
+## Installation for Users
+
+Once published, users can install your package by:
+
+1. **Creating `.npmrc` in their project:**
+   ```
+   @YOUR_GITHUB_USERNAME:registry=https://npm.pkg.github.com
+   //npm.pkg.github.com/:_authToken=THEIR_GITHUB_TOKEN
+   ```
+
+2. **Installing the package:**
+   ```bash
+   npm install @YOUR_GITHUB_USERNAME/ngx-angular-query-builder
+   ```
+
+## Troubleshooting
+
+### Common Issues:
+
+1. **Authentication Error:**
+   - Ensure you are using a GitHub classic access token with `write:packages` scope
+   - Verify the token is not expired
+
+2. **Package Not Found:**
+   - Check the package name includes the @csfloat scope
+   - Ensure the repository is public and you have access to it
+
+4. **Workflow Failures:**
+   - Check the Actions tab for detailed error logs
+   - Ensure GITHUB_TOKEN has sufficient permissions

README.md

@@ -32,6 +32,25 @@ Use the following versions depending upon your angular version
 - Angular 18 - Versions 18.x.x
 - Angular 19 - Versions 19.x.x
 
+# Installation
+
+## From GitHub Package Registry
+
+To install from GitHub Package Registry, you need to:
+
+1. Create a `.npmrc` file in your project root with:
+```
+@your-github-username:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
+```
+
+2. Install the package:
+```bash
+npm install @csfloat/ngx-angular-query-builder
+```
+
+**Note:** You'll need a [GitHub Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `read:packages` scope to install packages from GitHub Package Registry.
+
 # Examples
 
 npm install ngx-angular-query-builder

projects/ngx-angular-query-builder/package.json

@@ -1,8 +1,15 @@
 {
-  "name": "ngx-angular-query-builder",
+  "name": "@csfloat/ngx-angular-query-builder",
   "version": "19.0.0",
   "description": "Port of angular2-query-builder from github.com/designermanjeets/Angular-QueryBuilder in order to support angular 12+",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/csfloat/ngx-angular-query-builder.git"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
   "peerDependencies": {
     "@angular/common": "^19.2.14",
     "@angular/core": "^19.2.14"