@koobiq/icons 7.2.0 → 8.0.0-beta.5

package/CHANGELOG.md

@@ -1,70 +1,6 @@
-# 7.2.0 (2024-07-18)
+# 8.0.0-beta.5 (2024-09-05)
 
 ### Icons
 
- * feature  updated utils npm scope ([#DS-2155](https://github.com/koobiq/icons/issues/issue/DS-2155)) 9bfc67b
- * feature  добавление изображений ([#DS-2579](https://github.com/koobiq/icons/issues/issue/DS-2579)) 3998cef
-
-## 7.1.2 (2024-05-15)
-
-### Icons
-
- * bug fix  Иконки не закрашиваются (#DS-2163) 217f823
- * bug fix  removed hardcoded fill color in output (#DS-2391) 1c2ce2f
-
-## 7.1.1 (2023-10-04)
-
-### Icons
-
-* fix  font metrics to align icons with text using baseline correctly
-* fix  font-size css and scss rule
-* fix  html-preview document with correct mc prefix
-
-# 7.1.0 "Wistful Magi" (2023-08-18)
-
-### Icons
-
- * feature  change npm scope to koobiq f4c38b0
-
-## 7.0.8 "Yellowy Calash" (2023-06-28)
-
-### Icons
-
- * bug fix  имя fontFamily и font-styles 3594549
-
-## 7.0.7 "Disjoint Janke" (2023-06-28)
-
-### Icons
-
- * bug fix  добавление в инфо file-empty_16 bded8be
- * bug fix  размер иконок для шрифта dc08971
-
-## 7.0.6 "Hardball Embarkation" (2023-06-26)
-
-## 7.0.5 "Candescent Unavoidable" (2023-06-26)
-
-## 7.0.4 "Quatern X 3" (2023-06-26)
-
-### Icons
-
- * bug fix  генерация спрайта 2d2240c
- * bug fix  приведение формата пакета 064008e
-
-## 7.0.3 "Quincentenary Holder" (2023-06-26)
-
-## 7.0.2 "Happening Yannick" (2023-06-26)
-
-### Icons
-
- * feature  добавление иконок svg file-empty, triandle-left, upload-to-cloud f3b7f0c
-
-## 7.0.1 "Flavor Icons" (2023-06-26)
-
-# 1.0.0 "Zoogenic Catmint" (2022-12-28)
-
-### Icons
-
- * bug fix  **build:** заливка SVG иконок d3a5c63
- * bug fix  **build:** codepoint convert from hex to numeric 5cf4a21
- * feature  **build:** настройка публикации пакета (#DS-1244) 09a4452
+ * bug fix  updated readme file 239441b
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Mike Ozornin, Oleg Pimenov
+Copyright (c) 2024 Koobiq Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,4 @@
-# Icons
+# Koobiq Icons
 
 # How to use package
 
@@ -6,75 +6,21 @@
 npm i @koobiq/icons
 ```
 
-# Package structure
-
-```bash
-.
-├── CHANGELOG.md
-├── LICENSE
-├── README.md
-├── dist
-│   ├── fonts
-│   │   ├── mc-icons.css
-│   │   ├── mc-icons.html
-│   │   ├── mc-icons.scss
-│   │   ├── mc-icons.ttf
-│   │   └── mc-icons.woff
-│   ├── info
-│   │   └── mc-icons-info.json
-│   ├── svg
-│   │   ├── angle-down-L_16.svg
-│   │   ├── angle-down-L_24.svg
-│   │   ├── angle-down-M_16.svg
-│   │   └── angle-down-M_24.svg
-│   └── symbol
-│       ├── sprite.scss
-│       ├── sprite.symbol.html
-│       └── svg
-│           └── sprite.symbol.svg
-└── package.json
-```
-
-# How to rebuild package locally
-
-## Install dependencies
-Install dependencies by running:
-
-```
-npm install
-```
-
-## Sync with Figma
-
-Create a file with name `.env` and add there your Figma access token.
-
-```
-npm run figma:sync
-```
-
-## Build all packages
-
-```
-npm run build:all
-```
-
-Output will be exported to a `dist/icons` folder.
-
 # Publish new version
 
 ## Step 1. Prepare and environment
 Install dependencies by running:
 
 ```
-npm install
+yarn install
 ```
 
 ## Step 2. Draw an icon
 
-1. Draw your icon in [Koobiq Icons](https://www.figma.com/file/oQC47kSeukdqLMNh4IUhke/Mosaic-icons?type=design&node-id=0-4&mode=design&t=KCsYZb777ReIZMPY-11) figma file.
-1. Make icons contains the only single outlined and flattened path with name `shape` (second-color path with name `shape-2`). 
-1. Using a Fill Rule Editor plugin, set shapes' fill rule to Non-zero fill. Make sure icon is rendered correctly.
-1. Run flatten for shapes one more time (there is a bug in Figma).
+1. Draw your icon in [Koobiq Icons](https://www.figma.com/design/72HEcN92QnW9IQSXzmIYZX/Koobiq-Icons?m=auto&node-id=1320-21123&t=MZ7yMcUekVdv0doO-1) figma file.
+2. Make icons contains the only single outlined and flattened path with name `shape` (second-color path with name `shape-2`).
+3. Using a Fill Rule Editor plugin, set shapes' fill rule to Non-zero fill. Make sure icon is rendered correctly.
+4. Run flatten for shapes one more time (there is a bug in Figma).
 
 ## Step 3. Export icons from figma
 
@@ -82,7 +28,7 @@ Create a file with name `.env` and add there your Figma access token.
 
 To export your icons (SVG) from Figma run the command:
 ```
-npm run figma:sync
+yarn run figma:sync
 ```
 
 ## Step 4.
@@ -91,13 +37,13 @@ Change `mapping.json`:
 * Add an entry into `mapping.json` with a new codepoint keys.
 * Edit the name of an icon in the `mapping.json` in case of icon rename
 
-Commit SVG files `mapping.json` and and push all changes to git.
+Commit SVG files `mapping.json` and push all changes to git.
 
 ## Step 5.
 
 Run stage commit script to create a new release tag.
 ```
-npm run stage:commit
+yarn run stage:commit
 ```
 
 Use semver for version naming. So increment major (first) version number if any of these changes were made:
@@ -105,20 +51,3 @@ Use semver for version naming. So increment major (first) version number if any
 * Any icon name was changed (breaking changes for front-end developers)
 * Any icon codepoint was changed (breaking changes for tech writers)
 * Significant changes in icon metaphor (breaking changes for all)
-
-# Using CSS Classes
-Create a DOM element/container that contains ```mc-icon``` and the icon name like:
-
-```html
-<div class='mc-icon mc-angle-down-L_16'></div>
-
-```
-# Using SVG sprites
-
-When needing to use the `sprite.symbol.svg` sprite file, you can reference icons using the following method:
-
-```html
-<svg>
-    <use xlink:href="sprite.symbol.svg#add" />
-</svg>
-```