yudu-component-kit 0.0.2 → 0.0.4

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.
Files changed (2) hide show
  1. package/README.md +17 -51
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -1,63 +1,29 @@
1
+ <!-- ![Logo Fine Dev](./projects/yudu-component-kit/assets/logo-fine-dev.png-->
1
2
  # YuduComponentKit
2
3
 
3
- This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
4
+ ## ⚠️ **This library is currently under construction.**
4
5
 
5
- ## Code scaffolding
6
+ - Some features, components, and styles may change in future versions.
6
7
 
7
- Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
8
8
 
9
- ```bash
10
- ng generate component component-name
11
- ```
12
-
13
- For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
14
-
15
- ```bash
16
- ng generate --help
17
- ```
18
-
19
- ## Building
20
-
21
- To build the library, run:
22
-
23
- ```bash
24
- ng build yudu-component-kit
25
- ```
9
+ ## 🚀 Features
26
10
 
27
- This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
11
+ - ⚡ Built for Angular **v20+**
12
+ - 🧱 Atomic and modular architecture
13
+ - 🌗 Supports **Dark / Light** themes
14
+ - 🧩 Reusable UI components (Buttons, Cards, Modals, etc.)
15
+ - 🧪 100% compatible with **Angular CLI**, **Standalone Components**, and **SSR**
28
16
 
29
- ### Publishing the Library
30
-
31
- Once the project is built, you can publish your library by following these steps:
32
-
33
- 1. Navigate to the `dist` directory:
34
- ```bash
35
- cd dist/yudu-component-kit
36
- ```
37
-
38
- 2. Run the `npm publish` command to publish your library to the npm registry:
39
- ```bash
40
- npm publish
41
- ```
42
-
43
- ## Running unit tests
44
-
45
- To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
17
+ ## 📦 Installation
46
18
 
47
19
  ```bash
48
- ng test
20
+ npm i yudu-component-kit
49
21
  ```
50
22
 
51
- ## Running end-to-end tests
52
-
53
- For end-to-end (e2e) testing, run:
54
-
55
- ```bash
56
- ng e2e
57
- ```
58
-
59
- Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
60
-
61
- ## Additional Resources
23
+ ## Components status
24
+ - Button ✅
25
+ - Header 👷🏾
26
+ - Footer 👷🏾
27
+ - Sidebar 👷🏾
62
28
 
63
- For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
29
+ This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "yudu-component-kit",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
+ "license": "MIT",
4
5
  "repository": {
5
6
  "type": "git",
6
7
  "url": "https://github.com/FineYUDU/YuduComponentKit"