🔖 Release eds-icons@0.11.0 (#2290)

* 🔖 Release eds-icons@0.11.0 * 📝 Updated README * ♻️ simplified readme
equinor · Jun 9, 2022 · 1831936 · 1831936
1 parent 9b201b8
commit 1831936
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 11 deletions.
diff --git a/packages/eds-icons/CHANGELOG.md b/packages/eds-icons/CHANGELOG.md
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.11.0] - 2022-06-xx
+## [0.11.0] - 2022-06-09
 
 ## Added
 
@@ -17,7 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Fixed
 
-- Fixed typo in icons
+- Fixed typo in icons. Make sure to update the following icons to fixed name
   - `communte` -> `commute`
   - `headseat_mic` -> `headset_mic`
   - `desktop_windwos` -> `desktop_windows`
@@ -26,6 +26,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `mood_extreamly_sad` -> `mood_extremely_sad`
   - `mood_extreamly_happy` -> `mood_extremely_happy`
 
+## Removed
+
+- `communte`
+- `headseat_mic`
+- `desktop_windwos`
+- `breifcase`
+- `format_stikethrough`
+- `mood_extreamly_sad`
+- `mood_extreamly_happy`
+
 ## [0.10.0] - 2021-12-20
 
 ## Added

diff --git a/packages/eds-icons/README.md b/packages/eds-icons/README.md
@@ -39,23 +39,29 @@ Icon.add({ save }) // (this needs only be done once)
 
 ```
 
-### FAQ
+### Other web frameworks
 
-* If you are using NodeJS 13+ for module loading, it now has native ES modules support. Add `"type":"module"` to your apps `package.json` to enable this.
+You can render the EDS icons using plain [svg](https://developer.mozilla.org/en-US/docs/Web/SVG).
 
-* If you get a syntax error trying to import ES module, try importing the CJS module as not all loaders have support for ES modules yet
+⚠️ Due to how Figma parses and exports svg icons the following attributes must be added to your `<path>` element; `fill-rule="evenodd" clip-rule="evenodd"`.
 
-#### Rendering icons
+These are not included to reduce bundle size as they are needed for every icon.
 
-You can render it using plain [svg](https://developer.mozilla.org/en-US/docs/Web/SVG) or use our provided [React Icon component](#React) in [@equinor/eds-core-react](https://www.npmjs.com/package/@equinor/eds-core-react)
+```javascript
+import { save } from '@equinor/eds-icons'
+
+<svg viewBox={`0 0 ${save.width} ${save.height}`}>
+  <path d={save.svgPathData} fill-rule="evenodd" clip-rule="evenodd">
+</svg>
+```
 
-⚠️ Due to how Figma parses and exports svg icons the following attributes must be added to your `<path></path>` element; `fill-rule="evenodd" clip-rule="evenodd"`
+#### Icon names
 
-Use [EDS Assets in Figma](https://www.figma.com/file/BQjYMxdSdgRkdhKTDDU7L4KU/Assets?node-id=2%3A3)(Equinor Figma account needed🔒) or [storefront](https://eds.equinor.com/assets/system-icons/library/) for icon names. Spaces in icon names are replaced with underscores. 
+Use [EDS Assets in Figma](https://www.figma.com/file/BQjYMxdSdgRkdhKTDDU7L4KU/Assets?node-id=2%3A3)(Equinor Figma account needed🔒) or our [icon preview in Storybook](https://eds-storybook-react.azurewebsites.net/?path=/story/icons--preview) for icon names. Spaces in icon names are replaced with underscores. 
 
 `star-filled -> star_filled`.
 
-### Example of javascript object data
+### Example of icon data
 
 ```javascript
 {
@@ -67,6 +73,12 @@ Use [EDS Assets in Figma](https://www.figma.com/file/BQjYMxdSdgRkdhKTDDU7L4KU/As
 }
 ```
 
+### FAQ
+
+* If you are using NodeJS 13+ for module loading, it now has native ES modules support. Add `"type":"module"` to your apps `package.json` to enable this.
+
+* If you get a syntax error trying to import ES module, try importing the CJS module as not all loaders have support for ES modules yet
+
 ## Credits
 
 The EDS system icons are built on a copy of the [Outlined Material Design](https://material.io/resources/icons/?style=outline) icons provided open-source by Google. The icons have been customised and renamed for Equinor’s use.
diff --git a/packages/eds-icons/package.json b/packages/eds-icons/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@equinor/eds-icons",
-  "version": "0.10.0-dev.202205096",
+  "version": "0.11.0",
   "description": "Icons from the Equinor Design System",
   "main": "dist/icons.cjs.js",
   "module": "dist/icons.esm.js",