From 5241e126c660e5ced50afbac10e220e8b9b224e6 Mon Sep 17 00:00:00 2001 From: zaaakher Date: Mon, 20 Nov 2023 14:08:16 +0300 Subject: [PATCH] chore: updated readme --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a463416..5a40fc2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# SVG Country Flags for React (Package Name) +# ALAM + +SVG Country Flags for React (Package Name) ## Description @@ -16,7 +18,7 @@ This NPM package provides a collection of SVG country flags, optimized for React To install the package, run the following command in your project directory: ```bash -npm install [your-package-name] --save +npm install @sikka/alam --save ``` ## Usage @@ -24,11 +26,11 @@ npm install [your-package-name] --save Import the flag component in your React application: ```jsx -import { CountryFlag } from '[your-package-name]'; +import { SA } from '@sikka/alam'; const MyComponent = () => (
- +
); @@ -59,14 +61,6 @@ We welcome contributions to this package. If you have a suggestion or fix: Distributed under the MIT License. See `LICENSE` file for more information. -## Author - -- Your Name - [@YourGitHub](https://github.com/YourGitHub) - ## Acknowledgments -- List any other contributors or sources of inspiration. - ---- - -Feel free to modify this template to suit your specific package details and personal style. Remember to replace placeholders (like `[your-package-name]`) with actual values relevant to your package. +- The SVG files of the flags were taken from [yammadev/flag-icons](https://github.com/yammadev/flag-icons).