From f1115b91c7e5f5d6c0180393fa009a41952807c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20W=C3=BCrthner?= <5859228+crysxd@users.noreply.github.com> Date: Tue, 28 May 2024 12:00:44 +0200 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc03d3b..49fd267 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,31 @@ Features: - Support for modes and variables in Figma - Code generation using Jinja2 templating syntax for any code language - Export of icons as SVG, PDF, PNG, WEBP or Android XML vectors -- Simple configuration +- Simple configuration with many options + +``` +{ + "type": "values", + "templatePath": "../samples/AndroidValues.xml.figex", + "destinationPath": "~/Downloads/AndroidValuesModeB.xml", + "defaultMode": "modeB", + "templateVariables": { + "templateVarDemo": "\uD83D\uDE80\uD83D\uDE80\uD83D\uDE80" + } +}, +{ + "type": "icons", + "format": "androidxml", + "filter": "{% if fullName|startsWith('icon-', true) %} true {% else %} false {% endif %}", + "fileNames" : "{{ fullName|replaceSpecialChars('_')|lowercase }}", + "destinationPath": "~/Downloads/icons", + "clearDestination": true + } +``` ## Installation -1. Download a release from the release list +1. Download a `figex.zip` from the [release list](https://github.com/iodigital-com/figex/releases) 2. Extract the zip file and place it in your system 3. Add the extracted directory to your system's `$PATH` (macOS) @@ -141,4 +161,4 @@ Hint: You can also use Jinja filters to modify the name, e.g. `{{ color.name|low - Clone the Git - `./gradlew clean build` will build the project and create files - in `figma-exported/build/distributions` \ No newline at end of file + in `figma-exported/build/distributions`