@gmlk-developer/flag-icons 7.5.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Panayiotis Lipiridis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# flag-icons
+
+> A curated collection of all country flags in SVG, plus the CSS for easier integration. See the [repository](https://github.com/GMLK-DEVELOPER/flag-icons).
+
+## Install
+
+You can either [download](https://github.com/GMLK-DEVELOPER/flag-icons/archive/main.zip) the whole project as is or install it via npm or Yarn:
+
+```bash
+npm install @gmlk-developer/flag-icons
+# or
+yarn add @gmlk-developer/flag-icons
+```
+
+## Usage
+
+First, you need to import css:
+
+```js
+import "/node_modules/@gmlk-developer/flag-icons/css/flag-icons.min.css";
+```
+
+or use CDN:
+
+```html
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/gh/GMLK-DEVELOPER/flag-icons@main/css/flag-icons.min.css"
+/>
+```
+
+or use SASS:
+
+```scss
+@use "node_modules/@gmlk-developer/flag-icons/sass/flag-icons";
+
+// or with custom configuration
+@use "node_modules/@gmlk-developer/flag-icons/sass/flag-icons" with (
+  // Override path to flags directory
+  $flag-icons-path: "node_modules/@gmlk-developer/flag-icons/flags",
+
+  // Include only specific country flags
+  $flag-icons-included-countries: ("gr", "de", "gb")
+);
+```
+
+You can find all available variables in [`sass/_variables.scss`](https://github.com/GMLK-DEVELOPER/flag-icons/blob/main/sass/_variables.scss).
+
+For using the flags inline with text add the classes `.fi` and `.fi-xx` (where `xx` is the [ISO 3166-1-alpha-2 code](https://www.iso.org/obp/ui/#search/code/) of a country) to an empty `<span>`. If you want to have a squared version flag then add the class `fis` as well. Example:
+
+```html
+<span class="fi fi-gr"></span> <span class="fi fi-gr fis"></span>
+```
+
+You could also apply this to any element, but in that case you'll have to use the `fib` instead of `fi` and you're set. This will add the correct background with the following CSS properties:
+
+```css
+background-size: contain;
+background-position: 50%;
+background-repeat: no-repeat;
+```
+
+Which means that the flag is just going to appear in the middle of an element, so you will have to set manually the correct size of 4 by 3 ratio or if it's squared add also the `flag-icon-squared` class.
+
+## Development
+
+Run the `yarn` to install the dependencies after cloning the project and you'll be able to:
+
+To build `*.scss` files
+
+```bash
+$ yarn build
+```
+
+To serve it on `localhost:8000`
+
+```bash
+$ yarn start
+```
+
+To have only specific countries in the css file, remove the ones that you don't need from the [`_flag-icons-list.scss`](https://github.com/GMLK-DEVELOPER/flag-icons/blob/main/sass/_flag-icons-list.scss) file and build it again.
+
+## Credits
+
+- This project wouldn't exist without the awesome and now deleted collection of SVG flags by [koppi](https://github.com/koppi).
+- Thank you [Andrejs Abrickis](https://twitter.com/andrejsabrickis) for providing the `flag-icons` name on [npm](https://www.npmjs.com/package/flag-icons).
+
+# flag-icons