fix: github actions

.github/workflows/new-contributors.yml

@@ -0,0 +1,33 @@
+name: New Contributors
+on: [issues, pull_request]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: wow-actions/welcome@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+          FIRST_ISSUE_REACTIONS: '+1, hooray, rocket, heart'
+          FIRST_ISSUE: |
+            👋 Hey @{{ author }}
+            <br>
+            Thanks for flagging your first issue! We're on it! Please provide all the details you can
+            <br>
+            Got a fix? Send a PR! 🚀 Check out our [local dev guide](https://github.com/udayvunnam/xng-breadcrumb/blob/main/docs/local-development-guide.md)
+
+          FIRST_PR_REACTIONS: '+1, hooray, rocket, heart'
+          FIRST_PR_COMMENT: |
+            👋 Hey @{{ author }}!
+            <br>
+            Thanks for the PR 😄! We'll review it ASAP 👀
+            <br>
+            Kindly ensure you've followed our contributing guidelines.
+
+          FIRST_PR_MERGED: |
+            🎉 @{{ author }}
+            Congrats on merging your first PR! Your changes will be included in the next xng-breadcrumb release
+
+          STAR_MESSAGE: If you like this project, please ⭐star⭐ our repo.
+
+

.github/workflows/release-please.yml

@@ -7,7 +7,7 @@ permissions:
   contents: write
   pull-requests: write
 
-name: release-please
+name: Release Please
 
 jobs:
   release-please:

.github/workflows/stale.yml

@@ -3,7 +3,7 @@
 # You can adjust the behavior by modifying this file.
 # For more information, see:
 # https://github.com/actions/stale
-name: Mark stale issues and pull requests
+name: Mark stale PR and issue
 
 on:
   schedule:

README.md

@@ -4,7 +4,7 @@
 
 > A lightweight, declarative and dynamic breadcrumbs solution for Angular 6 and beyond. <https://www.npmjs.com/package/xng-breadcrumb>
 
-[![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml)
+[![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/pr-checks.yml/badge.svg)](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/pr-checks.yml)
 [![npm version](https://img.shields.io/npm/v/xng-breadcrumb.svg)](https://www.npmjs.com/package/xng-breadcrumb)
 ![bundle size](https://img.shields.io/bundlephobia/minzip/xng-breadcrumb)
 [![license](https://img.shields.io/npm/l/xng-breadcrumb.svg)](https://github.com/udayvunnam/xng-breadcrumb/blob/main/LICENSE)

docs/README.md

@@ -4,7 +4,7 @@
 
 > A lightweight, declarative and dynamic breadcrumbs solution for Angular 6 and beyond. <https://www.npmjs.com/package/xng-breadcrumb>
 
-[![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml)
+[![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/pr-checks.yml/badge.svg)](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/pr-checks.yml)
 [![npm version](https://img.shields.io/npm/v/xng-breadcrumb.svg)](https://www.npmjs.com/package/xng-breadcrumb)
 ![bundle size](https://img.shields.io/bundlephobia/minzip/xng-breadcrumb)
 [![license](https://img.shields.io/npm/l/xng-breadcrumb.svg)](https://github.com/udayvunnam/xng-breadcrumb/blob/main/LICENSE)
@@ -20,16 +20,16 @@
 
 </div>
 
-## About
+## Why do you need Breadcrumbs?
 
 - In applications with deep navigation hierarchy, it is essential to have breadcrumbs.
 - Breadcrumbs easily allow going back to states higher up in the hierarchy.
 
 ## Documentation
 
-[A step by step guide to integrate xng-breadcrumb into your Angular application](https://udayvunnam.github.io/xng-breadcrumb/#/)
+A step by step guide to integrate xng-breadcrumb into your Angular application - https://udayvunnam.github.io/xng-breadcrumb
 
-## Demo
+## Demo Angular App using xng-breadcrumb
 
 [Demo App](https://xng-breadcrumb.vercel.app/) - A demo app showcasing `xng-breadcrumb` library usage in an Angular app. Navigate through different links to see breadcrumbs behavior.
 

docs/quickstart.md

@@ -10,22 +10,41 @@ pnpm add xng-breadcrumb
 yarn add xng-breadcrumb
 ```
 
-## Import BreadcrumbModule in app.module.ts
+## Standalone Components
+
+**app.component.ts**
+
+```javascript
+import { BreadcrumbComponent, BreadcrumbItemDirective } from 'xng-breadcrumb';
+
+@Component({
+  standalone: true,
+  imports: [RouterModule, BreadcrumbComponent, BreadcrumbItemDirective],
+  templateUrl: './app.component.html',
+  ...
+})
+export class AppComponent {}
+```
+
+**app.component.html**
+
+```html
+<xng-breadcrumb></xng-breadcrumb>
+```
+
+## Angular < 17, BreadcrumbModule
 
 ```javascript
 import {BreadcrumbModule} from 'xng-breadcrumb';
 
 @NgModule({
-  ...
   imports: [BreadcrumbModule],
   ...
 })
 export class AppModule { }
 ```
 
-## Add xng-breadcrumb selector anywhere in the app
-
-Usually it is added in app.component.html
+**Add xng-breadcrumb selector anywhere in the app, Usually it is added in app.component.html**
 
 ```html
 <xng-breadcrumb></xng-breadcrumb>

xng-breadcrumb/README.md

@@ -4,7 +4,7 @@
 
 > A lightweight, declarative and dynamic breadcrumbs solution for Angular 6 and beyond. <https://www.npmjs.com/package/xng-breadcrumb>
 
-[![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/ci.yml)
+[![CI](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/pr-checks.yml/badge.svg)](https://github.com/udayvunnam/xng-breadcrumb/actions/workflows/pr-checks.yml)
 [![npm version](https://img.shields.io/npm/v/xng-breadcrumb.svg)](https://www.npmjs.com/package/xng-breadcrumb)
 ![bundle size](https://img.shields.io/bundlephobia/minzip/xng-breadcrumb)
 [![license](https://img.shields.io/npm/l/xng-breadcrumb.svg)](https://github.com/udayvunnam/xng-breadcrumb/blob/main/LICENSE)
@@ -20,16 +20,16 @@
 
 </div>
 
-## About
+## Why do you need Breadcrumbs?
 
 - In applications with deep navigation hierarchy, it is essential to have breadcrumbs.
 - Breadcrumbs easily allow going back to states higher up in the hierarchy.
 
 ## Documentation
 
-[A step by step guide to integrate xng-breadcrumb into your Angular application](https://udayvunnam.github.io/xng-breadcrumb/#/)
+A step by step guide to integrate xng-breadcrumb into your Angular application - https://udayvunnam.github.io/xng-breadcrumb
 
-## Demo
+## Demo Angular App using xng-breadcrumb
 
 [Demo App](https://xng-breadcrumb.vercel.app/) - A demo app showcasing `xng-breadcrumb` library usage in an Angular app. Navigate through different links to see breadcrumbs behavior.