Skip to content

Commit 3bd55f0

Browse files
committed
Initial commit 🤔
1 parent b7ca1cb commit 3bd55f0

File tree

6 files changed

+1920
-0
lines changed

6 files changed

+1920
-0
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,6 @@ jspm_packages
3535

3636
# Optional REPL history
3737
.node_repl_history
38+
39+
# Ignore built files
40+
dist/*

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# typed-countries
22
An array of the world's countries, complete with full TypeScript declaration support.
3+
4+
## Installation
5+
6+
Install from the NPM registry with NPM itself, or with [Yarn](https://github.com/yarnpkg/yarn):
7+
8+
```sh
9+
# NPM:
10+
npm install typed-countries
11+
12+
# or Yarn:
13+
yarn add typed-countries
14+
```
15+
16+
## Usage
17+
18+
You can import the package with ES6-style imports, or through Node's require:
19+
20+
```js
21+
//ES6-style import
22+
import { countries } from "typed-countries";
23+
24+
//Require
25+
const countries = require("typed-countries").countries;
26+
```
27+
28+
This package also uses an ES6-style default export:
29+
30+
```js
31+
//ES6-style default import
32+
import countries from "typed-countries";
33+
34+
//Require
35+
const countries = require("typed-countries").default;
36+
```

0 commit comments

Comments
 (0)