From aa0b63e58cf770abbdb8b7c51a24a6eb869e00f1 Mon Sep 17 00:00:00 2001 From: codecalm Date: Sun, 15 Mar 2020 18:12:50 +0100 Subject: readme fix --- .gitignore | 1 + README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.md | 72 -------------------------------------------------------------- 3 files changed, 73 insertions(+), 72 deletions(-) create mode 100644 README.md delete mode 100644 readme.md diff --git a/.gitignore b/.gitignore index a529e7b..bdc37d5 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ node_modules/ package-lock.json Gemfile.lock packages/* +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..389dbcd --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# Tabler Icons + +A set of over 300 free MIT-licensed high-quality SVG icons for you to use in your web projects. Each icon is designed on a 24x24 grid and a `2px` stroke. + +``` +npm install tabler-icons --save +``` + +## Preview + +![](./.github/icons.svg) + + +## Usage + +All icons are built with SVG, so you can place them as ``, `background-image` and inline in HTML code. + +### HTML image + +If you load an icon as an image, you can modify its size using CSS. + +```html +icon title +``` + +### Inline HTML + +You can paste the content of the icon file into your HTML code to display it on the page. + +```html + + + ... + + Click me + +``` + +Thanks to that, you can change the size, color and the `stroke-width` of the icons with CSS code. + +```css +.icon-tabler { + color: red; + width: 32px; + height: 32px; + stroke-width: 1.25; +} +``` + +### SVG sprite + +Add an icon to be displayed on your page with the following markup (`activity` in the above example can be replaced with any valid icon name): + +```html + + + +``` + +## Multiple strokes + +All icons in this repository have been created with the value of the `stroke-width` property, so if you change the value, you can get different icon variants that will fit in well with your design. + +![](./.github/icons-stroke.svg) + +## License + +Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/master/LICENSE). diff --git a/readme.md b/readme.md deleted file mode 100644 index 389dbcd..0000000 --- a/readme.md +++ /dev/null @@ -1,72 +0,0 @@ -# Tabler Icons - -A set of over 300 free MIT-licensed high-quality SVG icons for you to use in your web projects. Each icon is designed on a 24x24 grid and a `2px` stroke. - -``` -npm install tabler-icons --save -``` - -## Preview - -![](./.github/icons.svg) - - -## Usage - -All icons are built with SVG, so you can place them as ``, `background-image` and inline in HTML code. - -### HTML image - -If you load an icon as an image, you can modify its size using CSS. - -```html -icon title -``` - -### Inline HTML - -You can paste the content of the icon file into your HTML code to display it on the page. - -```html - - - ... - - Click me - -``` - -Thanks to that, you can change the size, color and the `stroke-width` of the icons with CSS code. - -```css -.icon-tabler { - color: red; - width: 32px; - height: 32px; - stroke-width: 1.25; -} -``` - -### SVG sprite - -Add an icon to be displayed on your page with the following markup (`activity` in the above example can be replaced with any valid icon name): - -```html - - - -``` - -## Multiple strokes - -All icons in this repository have been created with the value of the `stroke-width` property, so if you change the value, you can get different icon variants that will fit in well with your design. - -![](./.github/icons-stroke.svg) - -## License - -Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/master/LICENSE). -- cgit v1.2.1