line-md 3.0.4 → 3.0.5

package/README.md

@@ -78,39 +78,38 @@ JSON format has the following properties:
 
 - `content` contains SVG content, as string.
 - `viewBox` contains icon viewBox attribute value, as object.
-- `classes` contains list of used CSS classes, where key is class name, value is an object (see below).
+- `classes` contains list of used CSS classes, where key is class name, value is string with rules.
+- `animations` is the same as `classes`, but for animation rules, so you can wrap it in `@media not (prefers-reduced-motion)` if needed.
 - `keyframes` contains list of used animations, where key is an animation name, value is CSS.
 
-Classes property is an object, with the following keys (all keys are optional):
+This is the final format used in [SVG Utils](https://github.com/cyberalien/svg-utils) package, supported by [Iconify Unplugin](https://github.com/iconify/iconify-unplugin).
 
-- `rules` contains rules as string.
-- `animation` contains rules for animations, as string. It is separate from `rules`, so you can wrap it in `@media not (prefers-reduced-motion)` if needed to make sure icons are not animated for users that prefer non-animated icons.
+Also, `@iconify-vue/line-md` and `@iconify-svelte/line-md` have pre-made components that are generated from this data and use CSS animations, see [Iconify documentation](https://iconify.design/docs/usage/svg-css/).
 
 TypeScript type used in generator for exporting these JSON files:
 
 ```ts
-interface CSSJSONExport {
+// From @cyberalien/svg-utils/lib/svg-css/icon/types.js
+// Reduced to include only properties used in this icon set, all rules and
+// keyframes in this repository are converted to strings to simplify parsing.
+interface SVGCSSIcon {
 	// SVG content
 	content: string;
 
 	// viewBox
-	viewBox: IconViewBox;
+	viewBox: IconViewBox | string;
 
 	// Classes, key is class name
-	classes: Record<string, CSSJSONExportRules>;
+	classes: Record<string, string>;
+
+	// Animations for classes
+	// Same as 'classes', but for animation properties, so it can be separated in the output CSS
+	animations?: Record<string, string>;
 
 	// Used keyframes, key is animation name
 	keyframes?: Record<string, string>;
 }
 
-interface CSSJSONExportRules {
-	// Basic rules, excluding animations
-	rules: string;
-
-	// Rules used by animations
-	animation?: string;
-}
-
 // From @cyberalien/svg-utils/lib/svg/viewbox/types.js
 interface IconViewBox {
 	left?: number;