@ngflux/ngflux 1.0.6 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,21 +1,54 @@
1
- # NgFlux Angular Library
1
+ <h1 align="center">NgFlux - A Powerful Angular Toolkit</h1>
2
2
 
3
- [![NPM version][npm-version-image]][npm-url]
4
- [![NPM downloads][npm-downloads-image]][npm-downloads-url]
5
- [![MIT License][license-image]][license-url]
3
+ <p align="center">
4
+ <img src="projects/docs//public/assets/images/icon.png" alt="angular-logo" height="120px" />
5
+ <br>
6
+ <em>NgFlux is a powerful, comprehensive toolkit for Angular developers. It provides a robust collection of pre-built UI components, utility services, reusable directives, custom pipes, and functional route guards designed to eliminate boilerplate and accelerate the development of awesome web applications.</em>
7
+ <br>
8
+ </p>
6
9
 
7
- NgFlux provides powerful angular components, services, directives, pipes, guards and many more features for building awesome applications.
10
+ <p align="center">
11
+ <a href="https://ngflux.cybos.dev">ngflux.cybos.dev</a>
12
+ </p>
8
13
 
9
- <!-- ## Resources -->
14
+ <p align="center">
15
+ <a href="https://www.npmjs.com/package/@ngflux/ngflux" title="NPM version">
16
+ <img src="https://img.shields.io/npm/v/@ngflux/ngflux.svg?style=flat" alt="" />
17
+ </a>
18
+ <a href="https://npmcharts.com/compare/@ngflux/ngflux?minimal=true" title="NPM downloads">
19
+ <img src="https://img.shields.io/npm/dw/@ngflux/ngflux" alt="" />
20
+ </a>
21
+ <a href="LICENSE" title="MIT License">
22
+ <img src="https://img.shields.io/github/license/NgFlux/ngflux" alt="" />
23
+ </a>
24
+ <a href="https://github.com/NgFlux/ngflux/blob/main/CONTRIBUTING.md" title="PRs Welcome">
25
+ <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="" />
26
+ </a>
27
+ </p>
10
28
 
11
- <!-- - [Wiki/Documentation][wiki-url] -->
12
- <!-- - [Blog][blog-url] -->
29
+ <hr>
30
+
31
+ ## Features
32
+
33
+ - **Premium Components:** Sleek, customizable, and accessible UI building blocks.
34
+ - **Smart Services:** Utility services that streamline state, notifications, and device detection.
35
+ - **Reusable Directives:** Enhance DOM behavior effortlessly (e.g., click-outside, infinite scroll, tooltips).
36
+ - **Custom Pipes:** Performance-optimized text formatting, date manipulation, and data transformation utilities.
37
+ - **Secure Guards:** Functional route guards to handle authentication, role-based access control (RBAC), and form deactivation.
38
+ - **Modern Angular Native:** Fully built for Modern Angular, supporting Standalone Components, Signals, and RxJS reactive patterns.
39
+
40
+
41
+
42
+ ## Getting Started
43
+
44
+ Visit our [Documentation][wiki-url] for more info.
13
45
 
14
46
  ## License
15
47
 
16
48
  NgFlux is freely distributable under the terms of the [MIT license][license-url].
17
49
 
18
- [wiki-url]: https://www.cyberpull.com/wiki/opensource/ngflux
50
+
51
+ [wiki-url]: https://ngflux.cybos.dev
19
52
  [blog-url]: https://www.cyberpull.com/blog/tag/ngflux
20
53
 
21
54
  [license-image]: https://img.shields.io/github/license/NgFlux/ngflux
@@ -26,3 +59,7 @@ NgFlux is freely distributable under the terms of the [MIT license][license-url]
26
59
 
27
60
  [npm-downloads-image]: https://img.shields.io/npm/dw/@ngflux/ngflux
28
61
  [npm-downloads-url]: https://npmcharts.com/compare/@ngflux/ngflux?minimal=true
62
+
63
+ [contrib-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
64
+ [contrib-url]: https://github.com/NgFlux/ngflux/blob/main/CONTRIBUTING.md
65
+