From 7266573fc119c9b2a57a849767f26bd2f7da46b6 Mon Sep 17 00:00:00 2001 From: "Suwart, Jan" Date: Thu, 17 Feb 2022 12:52:30 +0100 Subject: [PATCH] Update readme --- README.md | 2 +- projects/icon-sprite/README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1ab6b0e..b5099fb 100644 --- a/README.md +++ b/README.md @@ -212,7 +212,7 @@ Or use combinations of several methods to achieve better results, like described ## Compatibility -This library is optimized for Angular 12, for 11 use [v. 1.10](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.10), for 10 use [v. 1.9](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.9). +This library is optimized for Angular 12, for 11 use [v. 1.10](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.10.0), for 10 use [v. 1.9](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.9.1). If you combine multiple frameworks (i.e. React, Vue, etc.), it is recommended to use [svg-icon-sprite web component](https://www.npmjs.com/package/svg-icon-sprite) instead! ## Author & License diff --git a/projects/icon-sprite/README.md b/projects/icon-sprite/README.md index 7a156f3..b5099fb 100644 --- a/projects/icon-sprite/README.md +++ b/projects/icon-sprite/README.md @@ -45,10 +45,10 @@ To use your SVGs from a sprite you need to: ### Step 1: Generate the sprite First add the library [for sprite generation svg2sprite](https://github.com/mrmlnc/svg2sprite-cli) as a devDependency: - + ```json "devDependencies": { -"svg2sprite-cli": "^2.0.1" + "svg2sprite-cli": "^2.0.1" } ``` @@ -56,7 +56,7 @@ Each time you add an icon, you need to run the script generating the sprite. You ```json "scripts": { -"generate:svg-sprite": "svg2sprite ./src/assets/icons ./src/assets/sprites/sprite.svg --stripAttrs fill --stripAttrs stroke --stripAttrs id" + "generate:svg-sprite": "svg2sprite ./src/assets/icons ./src/assets/sprites/sprite.svg --stripAttrs fill --stripAttrs stroke --stripAttrs id" } ``` @@ -104,7 +104,7 @@ Having a dynamic icon name: ## Options - `src` - icon source name, the syntax is `path/file#icon` where `path` is relative to app folder, `file` is - the name of the sprite and `icon` is the filename of the svg icon. +the name of the sprite and `icon` is the filename of the svg icon. - `width` *optional* - width of the svg in any length unit, i.e. `32px`, `50%`, `auto` etc., default is `100%` - `height` *optional* - the height of the svg in any length unit, if undefined height will equal the width - `classes` *optional* - class name(s) for this icon, default is `icon` @@ -158,7 +158,7 @@ provide a separate sprite file that keeps the stroke and fill attributes: ```json "scripts": { -"generate:svg-multicolor-sprite": "svg2sprite ./src/assets/svg-images ./src/assets/sprites/image-sprite.svg" + "generate:svg-multicolor-sprite": "svg2sprite ./src/assets/svg-images ./src/assets/sprites/image-sprite.svg" } ``` @@ -212,7 +212,7 @@ Or use combinations of several methods to achieve better results, like described ## Compatibility -This library is optimized for Angular 12, for 11 use [v. 1.10](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.10), for 10 use [v. 1.9](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.9). +This library is optimized for Angular 12, for 11 use [v. 1.10](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.10.0), for 10 use [v. 1.9](https://www.npmjs.com/package/ng-svg-icon-sprite/v/1.9.1). If you combine multiple frameworks (i.e. React, Vue, etc.), it is recommended to use [svg-icon-sprite web component](https://www.npmjs.com/package/svg-icon-sprite) instead! ## Author & License