circle-flags/README.md
2020-07-25 16:16:46 +02:00

1.9 KiB

circle-flags

A collection of circular SVG country flags.

Usage

https://hatscripts.github.io/circle-flags/flags/xx.svg

(Where xx is the ISO 3166-1 alpha-2 code of a country).

For example, the following code:

<img src="https://hatscripts.github.io/circle-flags/flags/br.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/ca.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/gb.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/jp.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/mx.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/us.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/za.svg" width="48">

...produces this:

To view all the available flags, check the gallery.

Contributing

To contribute, you need to have svgo installed (version 1.2.0 or newer).

First, edit the relevant SVG files in the flags/ directory.

Then run svgo to optimize the SVG files:

svgo ./flags --recursive --config=svgo.yml

Then commit the changes, and submit them as a pull request.

React

License

This project is released under the MIT license.