From ee76116c2c569228b84df85af48ef9645c032dfa Mon Sep 17 00:00:00 2001 From: Diemen Design Date: Sat, 12 Jan 2019 18:20:42 +1100 Subject: [PATCH] Edit Readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aa7faf2..cac8780 100755 --- a/README.md +++ b/README.md @@ -2,18 +2,22 @@ Born out of frustration of other Icon Sets not containing Icons needed when deve What sets LibreICONS apart from the rest, are the little things. - The Icons are sized to 12px x 12px inside a 14px x 14px viewBox. -- Each Icon contains ARIA Markup to hide icons from Screen Readers to stop confusion between the Icons and any Presentational Elements that may contain them. +- Each Icon contains ARIA Markup to hide icons from Screen Readers to stop confusion between the Icons and any Presentational Elements that may contain them, and `role="image"` for presentational purposes. - The source of the Icons are all minified. - Being minified, also makes embedding cleaner, as we found including Icons using PHP or Javascript to embed icons can break the page layout. - The standard and original icon set contains no colour or sizing so they can be controlled via CSS or manipulated easily. Using the Icons: After downloading the project, copy the libreicons-svg.css or libreicons-svg.min.css file from the project css/ folder, and the svg/ folder directory into your project. -In the of your html, reference the location to your libreicons-svg.css. - + +In the `` of your html, reference the location to your libreicons-svg.css. +`` To use the icons in your pages you use -[svg file to include] +`[svg file to include]` +You can alternatively use any inline element. + Or you could do like we do with LibreCMS and use a PHP Function to inject the SVG File directly into your generated pages. This also allows you to have more control over the size, colour, and animation of your icons. TODO: +- Experiment with multi-coloured CSS controlled Icons. - Continue adding Colour Icons and editing existing ones.