expatbase/circle-flags
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor markup fixes to the README

Browse source
This commit is contained in:
Waldir Pimenta 2022-05-15 18:24:25 +01:00
parent 3a0c70b15f
commit 553674a376
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -4,12 +4,14 @@ A collection of circular SVG country flags.
## Usage ## Usage
``` ```text
https://hatscripts.github.io/circle-flags/flags/xx.svg https://hatscripts.github.io/circle-flags/flags/xx.svg
``` ```
(Where `xx` is the [ISO 3166-1 alpha-2 code](https://www.iso.org/obp/ui/#search/code/) of a country). (Where `xx` is the [ISO 3166-1 alpha-2 code](https://www.iso.org/obp/ui/#search/code/) of a country).
For example, the following code: For example, the following code:
```html ```html
<img src="https://hatscripts.github.io/circle-flags/flags/br.svg" width="48"> <img src="https://hatscripts.github.io/circle-flags/flags/br.svg" width="48">
<img src="https://hatscripts.github.io/circle-flags/flags/cn.svg" width="48"> <img src="https://hatscripts.github.io/circle-flags/flags/cn.svg" width="48">
@ -42,7 +44,7 @@ If you're using [React](https://reactjs.org), you may want to try the
If you want to install this package as a dependency, you can install it from this GitHub repository: If you want to install this package as a dependency, you can install it from this GitHub repository:
``` ```sh
npm install --save https://github.com/HatScripts/circle-flags npm install --save https://github.com/HatScripts/circle-flags
``` ```
@ -63,7 +65,7 @@ Then commit the changes, and submit them as a pull request.
### The color palette ### The color palette
Submitted flags should conform to the following color palette.<br> Submitted flags should conform to the following color palette.<br/>
Try to match the flag's original colors with the nearest color from the palette. Try to match the flag's original colors with the nearest color from the palette.
* `#eeeeee`: white * `#eeeeee`: white