soff-phone 0.0.5 → 0.0.6

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 +58 -6
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -6,11 +6,31 @@
6
6
 
7
7
  <div align="center">
8
8
 
9
+ [![npm](https://img.shields.io/npm/v/soff-phone)](https://www.npmjs.com/package/soff-phone)
10
+ [![License](https://img.shields.io/github/license/bledxs/soff-monorepo)](LICENSE)
11
+ [![Build Status](https://github.com/bledxs/soff-monorepo/actions/workflows/ci.yml/badge.svg)](https://github.com/bledxs/soff-monorepo/actions)
12
+ [![codecov](https://codecov.io/gh/bledxs/soff-monorepo/branch/master/graph/badge.svg)](https://codecov.io/gh/bledxs/soff-monorepo)
13
+ [![minzipped size](https://img.shields.io/bundlephobia/minzip/soff-phone)](https://bundlephobia.com/package/soff-phone)
14
+ [![All Contributors](https://img.shields.io/github/all-contributors/bledxs/soff-monorepo?color=ee8449&style=flat-square)](#contributors)
15
+
9
16
  </div>
10
17
 
11
18
  ---
12
19
 
13
- ## Features
20
+ **Zero dependencies** · **TypeScript** · **Tree-shakeable**
21
+
22
+ ## Table of Contents
23
+
24
+ - [Why?](#why)
25
+ - [Supported Countries](#supported-countries)
26
+ - [Install](#install)
27
+ - [Quick Start](#quick-start)
28
+ - [Bundle Size](#bundle-size)
29
+ - [Contributing](#contributing)
30
+ - [License](#license)
31
+ - [Contributors](#contributors)
32
+
33
+ ## Why?
14
34
 
15
35
  - 🌲 **Tree-shakeable**: Import only the locales you need
16
36
  - 📦 **Zero dependencies**: Lightweight and fast
@@ -47,17 +67,23 @@
47
67
  - 🇬🇧 **United Kingdom** (gb) - 10 digits
48
68
  - 🇮🇹 **Italy** (it) - 9-10 digits
49
69
 
50
- ## Installation
70
+ ## Install
51
71
 
52
72
  ```bash
73
+ # npm
53
74
  npm install soff-phone
54
- # or
75
+
76
+ # pnpm
55
77
  pnpm add soff-phone
56
- # or
78
+
79
+ # yarn
57
80
  yarn add soff-phone
81
+
82
+ # bun
83
+ bun add soff-phone
58
84
  ```
59
85
 
60
- ## Usage
86
+ ## Quick Start
61
87
 
62
88
  ### Colombia 🇨🇴
63
89
 
@@ -148,6 +174,32 @@ Each locale is individually tree-shakeable, so you only pay for what you use.
148
174
 
149
175
  **Example**: If you only import Colombia validation, your bundle will be ~1KB minified (~0.6KB gzipped).
150
176
 
177
+ ## Contributing
178
+
179
+ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
180
+
151
181
  ## License
152
182
 
153
- MIT © [Luis C. Rojas](https://github.com/bledxs)
183
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
184
+
185
+ ## Contributors
186
+
187
+ Thanks goes to these wonderful people ([emoji key](https://all-contributors.js.org/docs/en/emoji-key)):
188
+
189
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
190
+ <!-- prettier-ignore-start -->
191
+ <!-- markdownlint-disable -->
192
+ <table>
193
+ <tbody>
194
+ <tr>
195
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/bledxs"><img src="https://avatars.githubusercontent.com/u/90062924?v=4" width="100px;" alt="Luis C. Rojas"/><br /><sub><b>Luis C. Rojas</b></sub></a><br /><a href="https://github.com/bledxs/soff-monorepo/commits?author=bledxs" title="Code">💻</a> <a href="https://github.com/bledxs/soff-monorepo/commits?author=bledxs" title="Documentation">📖</a> <a href="#maintenance-bledxs" title="Maintenance">🚧</a></td>
196
+ </tr>
197
+ </tbody>
198
+ </table>
199
+
200
+ <!-- markdownlint-restore -->
201
+ <!-- prettier-ignore-end -->
202
+
203
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
204
+
205
+ This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "soff-phone",
3
- "version": "0.0.5",
3
+ "version": "0.0.6",
4
4
  "description": "Lightweight phone number validation and formatting library for global markets",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -273,12 +273,12 @@
273
273
  "@vitest/coverage-v8": "^4.0.16",
274
274
  "eslint": "^9.39.2",
275
275
  "eslint-config-prettier": "^10.1.8",
276
- "globals": "^16.5.0",
276
+ "globals": "^17.0.0",
277
277
  "prettier": "^3.7.4",
278
278
  "rimraf": "^6.1.2",
279
279
  "tsup": "^8.5.1",
280
280
  "typescript": "^5.9.3",
281
- "typescript-eslint": "^8.51.0",
281
+ "typescript-eslint": "^8.52.0",
282
282
  "vitest": "^4.0.15"
283
283
  },
284
284
  "publishConfig": {