@digibib/deichman-ui - npm Package Compare versions

Comparing version 6.9.1 to 7.0.0

CHANGELOG.md

@@ -5,2 +5,8 @@ # Change Log
 
+## 7.0.0
+
+### Changed
+
+- Added three new icons: Comic, Film and Music
+
 ## 6.9.0
@@ -7,0 +13,0 @@

package.json

 {
   "name": "@digibib/deichman-ui",
-  "version": "6.9.1",
+  "version": "7.0.0",
   "description": "Deichman style-guide and component library",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -41,2 +41,16 @@ ## Deichman-ui
 
+### Icons
+
+All icons are stored in the `/src/assets/icons` folder.
+
+##### Adding a new icon:
+
+- Export the icons for web!
+- It's important that they're as lean as possible since they'll be downloaded by all visitors. [Use this Optimizer if possible](https://petercollingridge.appspot.com/svg-optimiser).
+- Make sure the new icon has the same size/style/line width as the old files.
+- Add the icon to the folder and run `npm run icons`.
+- After the output file has been created (`public/icons.svg`), You need to manually replace any hex color values (taken from the source files) with `currentColor`. This will allow the icons to easily be colored when used. NB: Check the commit well to ensure you didn't edit any old icons/colors).
+- Add the new icon to the `stories/1-Base/3-icons.stories.js` file.
+- Publish new version of Deichman-UI.
+
 ### Publishing
@@ -43,0 +57,0 @@

No alert changes

Improved metrics

Total package byte prevSize

784486

increased by1.4%

Number of lines in readme file

77

increased by22.22%

No dependency changes