react-all-countries 1.0.0

package/README.md

@@ -0,0 +1,84 @@
+# react-all-countries
+
+All countries data — name, ISO short code, phone prefix, timezone, and flag.
+
+## Install
+
+```bash
+npm install react-all-countries
+```
+
+## Usage
+
+```js
+const countries = require("react-all-countries");
+
+const {
+  getCountryByCode,
+  getCountryByName,
+  getCountriesByCallingCode,
+  searchCountries,
+} = require("react-all-countries");
+
+console.log(countries.length); // 254
+
+const bd = getCountryByCode("BD");
+// {
+//   name: 'Bangladesh',
+//   shortName: 'BD',
+//   phonePrefix: '+880',
+//   timezones: 'UTC+06:00',
+//   flag: 'https://flags.restcountries.com/v5/svg/bd.svg'
+// }
+```
+
+### React example
+
+```jsx
+import countries, { getCountryByCode } from "react-all-countries";
+
+function CountrySelect() {
+  return (
+    <select>
+      {countries.map((c) => (
+        <option key={c.shortName || c.name} value={c.shortName}>
+          {c.name} ({c.phonePrefix})
+        </option>
+      ))}
+    </select>
+  );
+}
+
+function Flag({ code }) {
+  const country = getCountryByCode(code);
+  if (!country?.flag) return null;
+  return <img src={country.flag} alt={country.name} width={24} />;
+}
+```
+
+## Data shape
+
+```ts
+interface Country {
+  name: string;        // common name
+  shortName: string;   // ISO alpha-2
+  phonePrefix: string; // e.g. '+880'
+  timezones: string;   // first timezone
+  flag: string;        // SVG flag URL
+}
+```
+
+## API
+
+| Export | Description |
+|--------|-------------|
+| `countries` / default | Full country array |
+| `getCountries()` | Same as `countries` |
+| `getCountryByCode(code)` | Find by `shortName` |
+| `getCountryByName(name)` | Find by exact `name` |
+| `getCountriesByCallingCode(code)` | Filter by `phonePrefix` (`880` or `+880`) |
+| `searchCountries(query)` | Partial name search |
+
+## License
+
+MIT