From 8df71ae92c6a1a478d74c2e6a2cf8332e21f0ebb Mon Sep 17 00:00:00 2001 From: Florian Date: Thu, 22 Nov 2018 02:31:18 +0100 Subject: [PATCH] chore(docs): Add ref to font-icon-generator --- README.md | 45 ++++++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index baf29a13..da2e719e 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ ## Getting Started -The common.puml is required for the rest to work. +The common.puml is required for the rest to work. -```puml +```puml !include ../common.puml ``` -or via url -```puml + +or via url + +```puml !define ICONURL https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/v2.0.0 !includeurl ICONURL/common.puml ``` @@ -20,6 +22,7 @@ Import the sprites that you want !include ../font-awesome/database.puml !include ../font-awesome-5/database.puml ``` + or via url ```puml @@ -45,7 +48,7 @@ The macros are prefixed with the set and the name of the icon ``` Using the icon from devicons for mysql - + ```puml DEV_MYSQL(db1) DEV_MYSQL(db2,label of db2) @@ -60,15 +63,15 @@ DEV_MYSQL(db4,label of db4,database,red) #DeepSkyBlue The following icon sets are included: | Name | Index | -| ------------------------------------------------- | ----------------------------------------- | -| [Font-Awesome 4](https://fontawesome.com/v4.7.0/) | [List of macros](font-awesome/index.md) | -| [Font-Awesome 5](http://fontawesome.io/) | [List of macros](font-awesome-5/index.md) | +| ---------------------------------------------------------- | ----------------------------------------- | +| [Font-Awesome 4](https://fontawesome.com/v4.7.0/) | [List of macros](font-awesome/index.md) | +| [Font-Awesome 5](http://fontawesome.io/) | [List of macros](font-awesome-5/index.md) | | [Devicons](http://vorillaz.github.io/devicons) | [List of macros](devicons/index.md) | | [Govicons](http://govicons.io/) | [List of macros](govicons/index.md) | | [Weather](https://erikflowers.github.io/weather-icons/) | [List of macros](weather/index.md) | | [Material](http://google.github.io/material-design-icons/) | [List of macros](material/index.md) | -## Example +## Example ```puml @startuml @@ -106,25 +109,25 @@ web4 <--> db1 More examples can be found [here](examples/) +## Build + +Icons are generated with [font-icon-generator](https://github.com/tupadr3/font-icon-generator) + ## Note -* All brand icons are trademarks of their respective owners. -* Thanks to milo-minderbinder for [AWS-PlantUML](https://github.com/milo-minderbinder/AWS-PlantUML) + +- All brand icons are trademarks of their respective owners. +- Thanks to milo-minderbinder for [AWS-PlantUML](https://github.com/milo-minderbinder/AWS-PlantUML) ## Changelog -#### v2.0.0 +#### v2.0.0 -* Added fa5, weather, gov and material -* Updated dev and fa to latest version -* Fixed aspect ratios +- Added fa5, weather, gov and material +- Updated dev and fa to latest version +- Fixed aspect ratios #### v1.0.0 -* Intital release - +- Intital release Enjoy! - - - -