dz-wilayas-core 1.0.2 → 1.0.3

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,12 +1,20 @@
1
- # dz-wilayas-core
1
+ # dz-wilayas-core 🇩🇿
2
+ ![npm](https://img.shields.io/npm/v/dz-wilayas-core?color=white&style=for-the-badge&logo=npm&logoColor=white)
3
+ ![npm downloads](https://img.shields.io/npm/dm/dz-wilayas-core?color=black&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA3LjIyIDExLjc2Ij48cG9seWdvbiBwb2ludHM9IjQuNTkgNC45NCA0LjU5IDAgMi42MiAwIDIuNjIgNC45NCAwIDQuOTQgMy4yOCA5LjUzIDcuMjIgNC45NCA0LjU5IDQuOTQiLz48cmVjdCB4PSIwLjExIiB5PSIxMC43NiIgd2lkdGg9IjciIGhlaWdodD0iMSIvPjwvc3ZnPg==&logoColor=white)
4
+ ![license](https://img.shields.io/npm/l/dz-wilayas-core?&logoColor=orange&color=orange&style=for-the-badge&logo=open-source-initiative)
5
+ ![npm bundle size](https://img.shields.io/bundlephobia/min/dz-wilayas-core?color=lightblue&style=for-the-badge&logo=webpack&logoColor=lightblue)
6
+ ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?logo=typescript&style=for-the-badge&color=blue)
7
+ ![GitHub Repo stars](https://img.shields.io/github/stars/ThaBugMaker/dz-wilayas-core?color=yellow&style=for-the-badge&logo=github&logoColor=yellow)
8
+ ![GitHub last commit](https://img.shields.io/github/last-commit/ThaBugMaker/dz-wilayas-core?&style=for-the-badge&logo=git&logoColor=F05032&color=F05032)
9
+ ![GitHub issues](https://img.shields.io/github/issues/ThaBugMaker/dz-wilayas-core?color=red&style=for-the-badge&logo=github&logoColor=red)
2
10
 
3
- ![npm](https://img.shields.io/npm/v/dz-wilayas-core?color=blue) ![license](https://img.shields.io/npm/l/dz-wilayas-core) ![downloads](https://img.shields.io/npm/dt/dz-wilayas-core)
4
11
 
5
- **A TypeScript library providing Algeria's wilayas and baladiyat data with utility classes for easy lookup, search, and integration in any JavaScript or TypeScript project.**
12
+
13
+ **A TypeScript library providing Algeria's wilayat and baladiyat data with utility classes for easy lookup, search, and integration in any JavaScript or TypeScript project.**
6
14
 
7
15
  ---
8
16
 
9
- ## Table of Contents
17
+ ## 📑 Table of Contents
10
18
 
11
19
  - [Installation](#installation)
12
20
  - [Usage](#usage)
@@ -14,11 +22,13 @@
14
22
  - [Data](#data)
15
23
  - [TypeScript Support](#typescript-support)
16
24
  - [Contributing](#contributing)
25
+ - [Author](#author)
26
+ - [Credits](#credits)
17
27
  - [License](#license)
18
28
 
19
29
  ---
20
30
 
21
- ## Installation
31
+ ## ⚡ Installation
22
32
 
23
33
  ```bash
24
34
  npm install dz-wilayas-core
@@ -28,7 +38,7 @@ yarn add dz-wilayas-core
28
38
 
29
39
  ---
30
40
 
31
- ## Usage
41
+ ## 🚀 Usage
32
42
 
33
43
  ```ts
34
44
  import { WilayasStore, Wilaya, Baladiya } from "dz-wilayas-core";
@@ -52,7 +62,7 @@ console.log(algerWilaya, algerBaladiyat);
52
62
 
53
63
  ---
54
64
 
55
- ## API
65
+ ## 🔌 API
56
66
 
57
67
  ### `class WilayasStore`
58
68
 
@@ -65,7 +75,7 @@ console.log(algerWilaya, algerBaladiyat);
65
75
 
66
76
  ---
67
77
 
68
- ## Data
78
+ ## 📊 Data
69
79
 
70
80
  - **Wilaya** object example:
71
81
 
@@ -93,7 +103,7 @@ All data is **preloaded from JSON** and typed for TypeScript.
93
103
 
94
104
  ---
95
105
 
96
- ## TypeScript Support
106
+ ## 🟦 TypeScript Support
97
107
 
98
108
  - Fully **typed** out-of-the-box.
99
109
  - Provides `Wilaya` and `Baladiya` types.
@@ -101,16 +111,58 @@ All data is **preloaded from JSON** and typed for TypeScript.
101
111
 
102
112
  ---
103
113
 
104
- ## Contributing
114
+ ## 🤝 Contributing
105
115
 
106
116
  1. Fork the repo
107
117
  2. Create your branch (`git checkout -b feature/my-feature`)
108
118
  3. Commit your changes (`git commit -am 'Add my feature'`)
109
119
  4. Push to the branch (`git push origin feature/my-feature`)
110
120
  5. Open a Pull Request
121
+ 6. After your PR is merged, **uncomment the Contributors block below** and add yourself by replacing `<YourUsername>` with your GitHub username.
122
+
123
+ <!-- --- -->
124
+
125
+ <!--
126
+ ## 👥 Contributors
127
+
128
+ <table>
129
+ <tr>
130
+ <td align="center">
131
+ <a href="https://github.com/<YourUsername>">
132
+ <img src="https://avatars.githubusercontent.com/<YourUsername>" width="80px;" alt="<YourUsername>"/><br />
133
+ <sub><b><YourUsername></b></sub>
134
+ </a>
135
+ </td>
136
+ </tr>
137
+ </table> -->
138
+
111
139
 
112
140
  ---
113
141
 
114
- ## License
142
+ ## 👤 Author
143
+
144
+ <table>
145
+ <tr>
146
+ <td align="center">
147
+ <a href="https://github.com/ThaBugMaker">
148
+ <img src="https://avatars.githubusercontent.com/u/118787817?v=4" width="80px" style="border-radius:50%;" alt="ThaBugMaker"/><br>
149
+ <sub><b>ThaBugMaker</b></sub>
150
+ </a>
151
+ </td>
152
+ </tr>
153
+ </table>
154
+
155
+ ---
156
+ ## 🙏 Credits
157
+
158
+ - **Data source:** [Wilaya-Of-Algeria](https://github.com/AbderrahmeneDZ/Wilaya-Of-Algeria) by [AbderrahmeneDZ](https://github.com/AbderrahmeneDZ) and [yamanidev](https://github.com/yamanidev)
159
+
160
+ ---
161
+
162
+ ## 📄 License
115
163
 
116
164
  This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
165
+
166
+ ---
167
+
168
+ <p align="center">© 2025 ThaBugMaker All rights reserved.</p>
@@ -1,8 +1,8 @@
1
1
  /*!
2
- * dz-wilayas-core v1.0.0
2
+ * dz-wilayas-core v1.0.3
3
3
  * (c) 2025 ThaBugMaker
4
4
  * Released under the MIT License.
5
- * https://github.com/YourUsername/dz-wilayas-core
5
+ * https://github.com/ThaBugMaker/dz-wilayas-core
6
6
  */
7
7
  import { Baladiya } from "../types";
8
8
  export declare const baladiyat: Baladiya[];
@@ -1,8 +1,8 @@
1
1
  /*!
2
- * dz-wilayas-core v1.0.0
2
+ * dz-wilayas-core v1.0.3
3
3
  * (c) 2025 ThaBugMaker
4
4
  * Released under the MIT License.
5
- * https://github.com/YourUsername/dz-wilayas-core
5
+ * https://github.com/ThaBugMaker/dz-wilayas-core
6
6
  */
7
7
  import { Wilaya } from "../types";
8
8
  export declare const wilayas: Wilaya[];