feat: update example, update heroicons, add mini property

CHANGELOG.md

@@ -1,5 +1,15 @@
 # svelte-hero-icons
 
+## 5.0.0
+
+### Breaking Changes
+
+- update @steeze-ui/heroicons to v2.2.2 (heroicons@2.0.16)
+
+### Features
+
+- add _mini_ property
+
 ## 4.1.1
 
 ### Minor Changes

README.md

@@ -3,11 +3,7 @@
   <a href="https://www.npmjs.com/package/svelte-hero-icons"><img src="https://img.shields.io/npm/v/svelte-hero-icons.svg?style=flat" /></a>
 </div>
 
-## Important Info for Current or New Users
-
-This package won't be updated for the upcoming Heroicons 2.0 release and will stay as a reference to v1.x.
-
-If you want to use v2.0 Icons, check out [@steeze-ui/icons](https://github.com/steeze-ui/icons) which is meant as a successor of svelte-hero-icons and will be be maintained instead:
+> If you want to use more Icons Packs and components for multiple Frameworks (React, Vue, Lit and more), check out [@steeze-ui/icons](https://github.com/steeze-ui/icons) which is meant as a successor to svelte-hero-icons:
 
 ### What is @steeze-ui/Icons ?
 
@@ -42,10 +38,11 @@ npm i -D svelte-hero-icons
 
 - svelte-hero-icons should work with SvelteKit `without any configuration`
 - If you have any problems, this could help adding to your `vite.config.js`:
- ```js
- ssr: {
-    noExternal: ["svelte-hero-icons"],
-  }
+
+```js
+ssr: {
+   noExternal: ["svelte-hero-icons"],
+ }
 ```
 
 ## Usage
@@ -58,10 +55,18 @@ npm i -D svelte-hero-icons
   // Only import what you need!
   import { Icon, ArrowUp, Filter } from "svelte-hero-icons";
 </script>
+<!-- default it's using the outline version of this icon -->
+<Icon src="{Filter}" />
 
-<!-- use solid attribute to control whether to show solid or outline version of icon -->
+<!-- use solid attribute to display the solid version of this icon -->
 <Icon src="{Filter}" solid />
 
+<!-- use mini attribute to display the mini version of this icon -->
+<Icon src="{Filter}" mini />
+
+<!-- in this (rather unusual) case solid will have the precedence -->
+<Icon src="{Filter}" solid mini />
+
 <!-- use size attribute to set icon size (32 -> 32px | 2rem | 100% == default ) -->
 <Icon src="{ArrowUp}" size="32" />
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-hero-icons",
-  "version": "4.1.3",
+  "version": "5.0.0-next.0",
   "description": "Heroicons for Svelte (Project based on heroicons)",
   "repository": {
     "type": "git",
@@ -30,33 +30,40 @@
     }
   },
   "scripts": {
-    "dev": "svelte-kit dev",
-    "build": "svelte-kit build",
-    "package": "svelte-kit package",
-    "preview": "svelte-kit preview",
-    "release:next": "pnpm run package && cd package && pnpm publish --tag next",
-    "release": "pnpm run package && cd package && pnpm publish"
+    "dev": "vite dev",
+    "build": "vite build",
+    "preview": "vite preview",
+    "check": "svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-check --tsconfig ./tsconfig.json --watch",
+    "lint": "prettier --ignore-path .gitignore --check --plugin-search-dir=. .",
+    "format": "prettier --ignore-path .gitignore --write --plugin-search-dir=. .",
+    "package": "pnpm svelte-package"
   },
   "devDependencies": {
-    "@sveltejs/adapter-node": "next",
-    "@sveltejs/kit": "next",
-    "@types/node": "^16.11.20",
-    "svelte": "^3.46.2",
-    "svelte-check": "^2.3.0",
-    "svelte-preprocess": "^4.10.2",
+    "@sveltejs/adapter-auto": "2.0.0",
+    "@sveltejs/kit": "1.7.2",
+    "@sveltejs/package": "1.0.0-next.1",
+    "@types/node": "^17.0.45",
+    "esmo": "^0.14.1",
+    "prettier": "^2.8.4",
+    "prettier-plugin-svelte": "^2.9.0",
+    "svelte": "^3.55.1",
+    "svelte-check": "^3.0.3",
+    "svelte-preprocess": "^4.10.7",
     "svelte2tsx": "^0.4.14",
-    "tslib": "^2.3.1",
-    "typescript": "^4.5.4"
+    "tslib": "^2.5.0",
+    "typescript": "^4.9.5",
+    "vite": "^4.1.2"
   },
   "type": "module",
   "main": "index.js",
   "svelte": "index.js",
   "dependencies": {
-    "@steeze-ui/heroicons": "^2.0.10"
+    "@steeze-ui/heroicons": "^2.2.2"
   },
   "files": [
     "*.svelte",
     "*.d.ts",
     "*.js"
   ]
-}
+}