@bitrise/bitkit-v2 0.3.39 → 0.3.40

package/README.md

@@ -57,6 +57,33 @@ npm run build
 npm run theme:generate-types
 ```
 
+### Export SVG icons from Figma
+
+First you should create a Figma Personal Access Token to acces to the Bitkit Foundations file: https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens
+
+```bash
+FIGMA_TOKEN=<your-personal-access-token> npm run generate:icons
+```
+
+#### Manual Icon Overrides
+
+If you need to customize an icon (e.g., add animations), you can prevent it from being overwritten during generation by adding a skip marker:
+
+```tsx
+// @generate:skip
+// This file is manually maintained with custom animation.
+
+import { Icon, IconProps } from '@chakra-ui/react';
+// ... your custom implementation
+```
+
+Icons marked with `// @generate:skip` will:
+- Be preserved during regeneration
+- Still be exported in the barrel files
+- Appear in the generation summary as "skipped (manual)"
+
+You can also create custom icons that don't exist in Figma. Just add the skip marker and place them in the appropriate size folder (`lib/icons/16x16/` or `lib/icons/24x24/`). They'll be automatically included in exports.
+
 ## License
 
 MIT