Added README

eunarede · Sep 24, 2013 · 29246bb · 29246bb
1 parent 6ee96b9
commit 29246bb
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+country-flag-icons
+==================
+
+
+CSS classes
+-----------
+
+
+`.flag-icon`
+
+`.flag-icon-xx` where `xx` is the [ISO 3166-1-alpha-2 code](http://www.iso.org/iso/country_names_and_code_elements)
+
+`.flag-icon-squared` the squared version of the flag
+
+`.flag-icon-2x` 2 times bigger size
+
+`.flag-icon-3x` 3 times bigger size
+
+
+Usage
+-----
+
+    <span class="flag-icon flag-icon-gr"></span>
+    <span class="flag-icon flag-icon-gr flag-icon-2x"></span>
+    <span class="flag-icon flag-icon-gr flag-icon-3x"></span>
+
+    <span class="flag-icon flag-icon-gr flag-icon-squared"></span>
+    <span class="flag-icon flag-icon-gr flag-icon-squared flag-icon-2x"></span>
+    <span class="flag-icon flag-icon-gr flag-icon-squared flag-icon-3x"></span>