diff --git a/LICENSE b/LICENSE.md similarity index 98% rename from LICENSE rename to LICENSE.md index 176267b..87fb45d 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,4 +1,4 @@ -MIT License +# MIT License Copyright (c) 2022 HatScripts diff --git a/README.md b/README.md index b92e70a..685b09b 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,14 @@ A collection of circular SVG country flags. ## Usage -``` +```text 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). For example, the following code: + ```html @@ -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: -``` +```sh 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 -Submitted flags should conform to the following color palette.
+Submitted flags should conform to the following color palette.
Try to match the flag's original colors with the nearest color from the palette. * `#eeeeee`: white @@ -79,10 +81,11 @@ Try to match the flag's original colors with the nearest color from the palette. * `#0052b4`: blue Special cases: + * `#002266`: dark blue (only one usage: [ Chad](https://github.com/HatScripts/circle-flags/blob/gh-pages/flags/td.svg), to differentiate from [ Romania](https://github.com/HatScripts/circle-flags/blob/gh-pages/flags/ro.svg)) * `#4a1f63`: purple (only one usage: [ Balearic Islands](https://github.com/HatScripts/circle-flags/blob/gh-pages/flags/es-ib.svg)) * `#751a46`: dark pink (only one usage: [ Qatar](https://github.com/HatScripts/circle-flags/blob/gh-pages/flags/qa.svg)) ## License -This project is released under the [MIT license](LICENSE). +This project is released under the [MIT license](LICENSE.md).