Skip to content

Commit

Permalink
chore: bumped version to 0.0.10
Browse files Browse the repository at this point in the history
  • Loading branch information
saultharwat74 committed Sep 20, 2023
1 parent 27f6590 commit 69a49ad
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 28 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# ts-country

## 0.0.10

🚀 **Updated Country Data** 🌐

- Added FIPS & ISO Codes
- Included Currency Symbols
- Area & Government & Coastline Info Added

🚧 Regions Feature in Progress

## 0.0.9

### Patch Changes
Expand Down
59 changes: 32 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ pnpm add ts-country
| `getCountry` | Retrieves detailed information about a specific country. |
| `getCurrency` | Provides currency codes for a given country code. |
| `getLanguage` | Retrieves detailed language information for a specific country code. |
| `getCapital` | Retrieves the capital cities of various countries. |


`getCountry`
Expand All @@ -41,26 +42,27 @@ pnpm add ts-country
```typescript
import { getCountry } from "ts-country";

const countryInfo = getCountry();

// Accessing capital of the United States
const capital = countryInfo.US.capital; // Returns "Washington, D.C."
const countryInfo = getCountry() // Returns {
// capital: "Washington, D.C.",
// currency: { USD: "USD -> United States Dollar" },
// continent: "North America",
// languages: { en: { name: "English", native: "English" } },
// name: "United States",
// native: "United States",
// phone: [1],
// continents: ["North America"],
// emoji: "🇺🇸",
// timezone: "America/New_York",
// gmtoffset: "UTC-05:00",
// geonameId: 6252001
// fipsCode: "US",
// isoNumeric: "840",
// currencySymbol: "$",,
// area: 9372610,
// governmentType: Federal republic,
// coastline: 19.924
// }
```

Returned Values

- `capital`: Washington, D.C.
- `currency`: { USD: "USD" }
- `continent`: North America
- `languages`: { en: { name: "English", native: "English" } }
- `name`: United States
- `native`: United States
- `phone`: [1]
- `continents`: [North America]
- `emoji`: 🇺🇸
- `timezone`: America/New_York
- `gmtoffset`: UTC-05:00
- `geonameId`: 6252001

`getCurrency`

Expand All @@ -72,13 +74,9 @@ import { getCurrency } from "ts-country";
const currencyCodes = getCurrency("US");

// Accessing USD currency code
const usdCode = currencyCodes.USD; // Returns "United States Dollar (USD)"
const usdCode = currencyCodes.USD; // Returns "USD -> United States Dollar"
```

Returned Values

- `USD`: United States Dollar (USD)

`getLanguage`

> Retrieves detailed language information for a specific country code.
Expand All @@ -92,11 +90,18 @@ const languageInfo = getLanguage("US");
const englishInfo = languageInfo.en; // Returns { name: "English", native: "English" }
```

#### Returned Values
`getCapital`

- `name`: English
- `native`: English
> Retrieves the capital cities of various countries.
```typescript
import { getCapital } from "ts-country";


const capitals = getCapital();
// Accessing capital of the United States
const usCapital = capitals.US.capital; // Returns "Washington, D.C."
```
## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ts-country",
"version": "0.0.9",
"version": "0.0.10",
"description": "",
"private": false,
"main": "./dist/index.js",
Expand Down

0 comments on commit 69a49ad

Please sign in to comment.