countrynormalizer 0.1.1 → 0.1.2

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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +16 -0
  3. package/package.json +44 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 JackMcE
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,7 +1,23 @@
1
1
  # 🌎 Country Data Lookup And Normalizer 🌍
2
2
 
3
+ [![CI](https://github.com/JackMcE/CountryNormalizer/actions/workflows/ci.yml/badge.svg)](https://github.com/JackMcE/CountryNormalizer/actions/workflows/ci.yml)
4
+ [![npm version](https://img.shields.io/npm/v/countrynormalizer.svg)](https://www.npmjs.com/package/countrynormalizer)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
6
+ [![Coverage](https://codecov.io/gh/JackMcE/CountryNormalizer/branch/main/graph/badge.svg)](https://codecov.io/gh/JackMcE/CountryNormalizer)
7
+ [![npm downloads](https://img.shields.io/npm/dm/countrynormalizer.svg)](https://www.npmjs.com/package/countrynormalizer)
8
+
3
9
  A simple library for consolidation and reverse lookup of common ISO country data fields and calling codes all in one place.
4
10
 
11
+ ## Installation
12
+
13
+ ```bash
14
+ npm install countrynormalizer
15
+ ```
16
+
17
+ ```bash
18
+ bun add countrynormalizer
19
+ ```
20
+
5
21
  Developers routinely need to mix and match pieces of country data across an application.
6
22
 
7
23
  Some common examples are:
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "countrynormalizer",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
+ "description": "ISO 3166 country data lookup and normalization. Convert between alpha-2, alpha-3, ISO numbers, country names, calling codes, flag emojis, TLDs, continents, and demonyms.",
4
5
  "type": "module",
5
6
  "main": "./dist/index.js",
6
7
  "module": "./dist/index.js",
@@ -15,8 +16,50 @@
15
16
  "files": [
16
17
  "dist"
17
18
  ],
19
+ "keywords": [
20
+ "country",
21
+ "countries",
22
+ "iso-3166",
23
+ "iso3166",
24
+ "country-code",
25
+ "alpha-2",
26
+ "alpha-3",
27
+ "country-lookup",
28
+ "country-normalizer",
29
+ "country-normalize",
30
+ "calling-code",
31
+ "phone-code",
32
+ "dialing-code",
33
+ "flag-emoji",
34
+ "flag",
35
+ "tld",
36
+ "top-level-domain",
37
+ "continent",
38
+ "demonym",
39
+ "country-data",
40
+ "country-name",
41
+ "country-flag",
42
+ "country-phone",
43
+ "internationalization",
44
+ "i18n",
45
+ "localization",
46
+ "l10n",
47
+ "country-list",
48
+ "typescript"
49
+ ],
50
+ "author": "JackMcE",
51
+ "license": "MIT",
52
+ "repository": {
53
+ "type": "git",
54
+ "url": "https://github.com/JackMcE/CountryNormalizer.git"
55
+ },
56
+ "homepage": "https://github.com/JackMcE/CountryNormalizer#readme",
57
+ "bugs": {
58
+ "url": "https://github.com/JackMcE/CountryNormalizer/issues"
59
+ },
18
60
  "scripts": {
19
61
  "build": "bun run build.ts",
62
+ "test": "bun test",
20
63
  "extract-data": "bun ./tools/build-data.ts"
21
64
  },
22
65
  "devDependencies": {