diff --git a/README.md b/README.md index 65e78fc..e4dd41a 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,19 @@ -## Welcome to GitHub Pages +# circle-flags -You can use the [editor on GitHub](https://github.com/HatScripts/circle-flags/edit/master/README.md) to maintain and preview the content for your website in Markdown files. +A collection of circular SVG country flags. -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. +## Usage -### Markdown - -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for - -```markdown -Syntax highlighted code block - -# Header 1 -## Header 2 -### Header 3 - -- Bulleted -- List - -1. Numbered -2. List - -**Bold** and _Italic_ and `Code` text - -[Link](url) and ![Image](src) ``` +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 more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). +For example: -### Jekyll Themes +```html + +``` +Gives: -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/HatScripts/circle-flags/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file. - -### Support or Contact - -Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out. +