From d61252054fda5a6f50d37422f1be76265b525988 Mon Sep 17 00:00:00 2001 From: Panayiotis Lipiridis Date: Sun, 15 Nov 2015 17:42:59 +0100 Subject: [PATCH] Brought back the credits --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ef246fb5f..503940ae8 100644 --- a/README.md +++ b/README.md @@ -9,28 +9,31 @@ CSS for vector based country flags. See the Usage ----- -For using the flags inline with text add the classes `.flag-icon` and +For using the flags inline with text add the classes `.flag-icon` and `.flag-icon-xx` (where `xx` is the -[ISO 3166-1-alpha-2 code](http://www.iso.org/iso/country_names_and_code_elements) +[ISO 3166-1-alpha-2 code](http://www.iso.org/iso/country_names_and_code_elements) of a country) to an empty ``. If you want to have a squared version flag then add the class `flag-icon-squared` as well. Example: - - +```html + + +``` You could also apply this to any element, but in that case you'll have to use the `flag-icon-background` instead of `flag-icon` and you're set. This will add the correct background with the following CSS properties: - background-size: contain; - background-position: 50%; - background-repeat: no-repeat; +```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 +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 ----------- @@ -39,17 +42,29 @@ you'll be able to: To watch for changes and live reload if served - $ grunt +```bash +$ grunt +``` To build `*.less` files - $ grunt build +```bash +$ grunt build +``` To serve it on `localhost:8000` - $ grunt connect +```bash +$ grunt connect +``` To have only specific countries in the css file, remove the ones that you don't need from the [`flag-icon-list.less`](https://github.com/lipis/flag-icon-css/blob/master/less/flag-icon-list.less) 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).