From b36bc875e181b488b147099782520c6fd2765060 Mon Sep 17 00:00:00 2001
From: Anton <info@ensostudio.ru>
Date: Wed, 19 Jan 2022 04:40:51 +0300
Subject: Update README.md

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++------
 1 file changed, 36 insertions(+), 6 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 40281919..08fa1007 100644
--- a/README.md
+++ b/README.md
@@ -217,7 +217,7 @@ The default settings if you have not defined the file will be:
 {
   "includeIcons": [],
   "fontForge": "fontforge",
-  "strokeWidth": 2
+  "strokeWidth": null
 }
 ```
 
@@ -225,16 +225,16 @@ The fontforge executable needs to be in the path or you can set the path to the
 
 ```JSON
 {
-  "fontForge":"/Applications/FontForge.app/Contents/MacOS/FontForge"
+  "fontForge": "/Applications/FontForge.app/Contents/MacOS/FontForge"
 }
 ```
+
 To compile the fonts run:
 ```sh
 npm run build-iconfont
 ```
 
-By default the stroke width is 2. You can change the stroke width in the compile-options.json 
-
+By default the stroke width is 2. You can change the stroke width in the `compile-options.json`
 ```JSON
 {
   "strokeWidth": 1.5,
@@ -245,9 +245,39 @@ To reduce the font file size you can choose to compile a sub set of icons. When
 
 ```JSON
 {
-  "includeIcons":["alert-octagon","alert-triangle"]
+  "includeIcons": ["alert-octagon", "alert-triangle"]
+}
+```
+
+Optional property `includeCategories` - an array or string of icon categories to include, category names are case-issensetive.
+```JSON
+{
+  "includeCategories": ["Devices", "System"]
+}
+```
+or
+```JSON
+{
+  "includeCategories": "Devices System"
+}
+```
+
+Optional property `excludeIcons` - an array of icon names using to exclude some category icons:
+```JSON
+{
+  "includeCategories": ["system"],
+  "excludeIcons": ["adjustments"]
 }
-```  
+```
+
+Complex solution:
+```JSON
+{
+  "includeIcons": ["alert-octagon", "alert-triangle"],
+  "includeCategories": ["devices", "system"],
+  "excludeIcons": ["adjustments"]
+}
+```
 
 ### Svelte
 
-- 
cgit v1.2.1