Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zaaakher committed Nov 20, 2023
1 parent 160d9c9 commit 5241e12
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# SVG Country Flags for React (Package Name)
# ALAM

SVG Country Flags for React (Package Name)

## Description

Expand All @@ -16,19 +18,19 @@ 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

Import the flag component in your React application:

```jsx
import { CountryFlag } from '[your-package-name]';
import { SA } from '@sikka/alam';

const MyComponent = () => (
<div>
<CountryFlag countryCode="US" width="100" height="50" />
<SA />
</div>
);

Expand Down Expand Up @@ -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).

0 comments on commit 5241e12

Please sign in to comment.