		@@ -1,103 +0,84 @@
		# TSDX User Guide
		# Country Seeker Node Package

		Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
		This is a Node.js package that allows you to search for countries using different criteria such as country code, dial code, flag, or country name. It exports several functions that can be used in your Node.js projects to retrieve country data.

		> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.

		> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)

		## Commands
		## Installation
		To use this package, you can install it from npm using the following command:

		TSDX scaffolds your new library inside `/src`.
		```bash
		npm install country-seeker
		```
		## Usage
		To use this package, you first need to import it into your project:

		To run TSDX, use:

		```bash
		npm start # or yarn start
		import { getCountries, useCountry, useDialCode, useFlag, useCountryName, useCountryCode } from "country-seeker";
		```
		### `getCountries`
		This function returns an array of all the countries in the package's data:

		This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
		```bash
		const countries = getCountries();
		console.log(countries);
		```

		To do a one-off build, use `npm run build` or `yarn build`.
		### useCountry
		This function takes an object with two properties, type and value, and returns the first country that matches the given criteria:

		To run tests, use `npm test` or `yarn test`.
		```bash
		const countryByCode = useCountry({ type: 'code', value: 'US' });
		console.log(countryByCode);

		## Configuration
		const countryByDialCode = useCountry({ type: 'dial_code', value: '+1' });
		console.log(countryByDialCode);

		Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
		const countryByFlag = useCountry({ type: 'flag', value: '🇺🇸' });
		console.log(countryByFlag);

		### Jest
		const countryByName = useCountry({ type: 'name', value: 'United States' });
		console.log(countryByName);

		Jest tests are set up to run with `npm test` or `yarn test`.
		```

		### Bundle Analysis
		### useDialCode
		This function takes a value parameter, which represents the dial code of the country, and returns the first country that matches the given dial code:

		[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
		```bash
		const country = useDialCode({ value: '+1' });
		console.log(country);

		#### Setup Files

		This is the folder structure we set up for you:

		```txt
		/src
		index.tsx # EDIT THIS
		/test
		blah.test.tsx # EDIT THIS
		.gitignore
		package.json
		README.md # EDIT THIS
		tsconfig.json
		```

		### Rollup
		### useFlag
		This function takes a value parameter, which represents the flag of the country, and returns the first country that matches the given flag:

		TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
		```bash
		const country = useFlag({ value: '🇺🇸' });
		console.log(country);

		### TypeScript
		```

		`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
		### useCountryName
		This function takes a value parameter, which represents the name of the country, and returns the first country that matches the given name::

		## Continuous Integration
		```bash
		const country = useCountryName({ value: 'United States' });
		console.log(country);
		```

		### GitHub Actions
		### useCountryCode
		This function takes a value parameter, which represents the code of the country, and returns the first country that matches the given code:

		Two actions are added by default:
		```bash
		const country = useCountryCode({ value: 'US' });
		console.log(country);

		- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
		- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)

		## Optimizations

		Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:

		```js
		// ./types/index.d.ts
		declare var __DEV__: boolean;

		// inside your code...
		if (__DEV__) {
		console.log('foo');
		}
		```

		You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.

		## Module Formats
		## Contributing

		CJS, ESModules, and UMD module formats are supported.

		The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.

		## Named Exports

		Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.

		## Including Styles

		There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.

		For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.

		## Publishing to NPM

		We recommend using [np](https://github.com/sindresorhus/np).
		If you find a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/gabrielopeyemi/country-seeker) . Pull requests are also welcome. .
		# country-seeker

country-seeker - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics