solid-toast - npm Package Compare versions

Comparing version 0.0.5 to 0.0.8

package.json

 {
   "name": "solid-toast",
-  "version": "0.0.5",
+  "version": "0.0.8",
   "description": "Customizable Toast Notifications for SolidJS",
@@ -44,9 +44,7 @@ "main": "./dist/solid-toast.cjs.js",
   "devDependencies": {
+    "@types/node": "^17.0.35",
     "typescript": "^4.6.4",
     "vite": "^2.9.9",
     "vite-plugin-solid": "^2.2.6"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
   }
 }

README.md

@@ -1,2 +0,56 @@
-# Solid Toast
-Customizable Toast Notifications for SolidJS
+<a href="https://github.com/ardeora/solid-toast"><img alt="Solid Toast header image showing a cute toaster with a toast popping out" src="https://github.com/ardeora/solid-toast/raw/main/assets/header.png"/></a>
+
+<div align="center">
+    <img src="https://badgen.net/npm/v/solid-toast" alt="NPM Version" />
+  <img src="https://badgen.net/bundlephobia/minzip/solid-toast" alt="Minzipped size"/>
+    <img src="https://github.com/ardeora/solid-toast/workflows/build/badge.svg" alt="Build Status" />
+</a>
+</div>
+<br />
+<div align="center"><strong>Create beautiful, customizable toasts in SolidJS.</strong></div>
+
+<br />
+
+## Features
+
+- **Easily Customizable**
+- **Promise API** - _Automatic loader from a promise_
+- **Lightweight** - _less than 4kb including styles and animations_
+- **Accessible**
+
+## Installation
+
+#### With yarn
+
+```sh
+yarn add solid-toast
+```
+
+#### With NPM
+
+```sh
+npm install solid-toast
+```
+
+## Getting Started
+
+Add a Toaster Component to the top level of your component tree. This . Now you can trigger `toast()` from anywhere!
+
+```jsx
+import toast, { Toaster } from 'react-hot-toast';
+
+const notify = () => toast('Here is your toast.');
+
+const App = () => {
+  return (
+    <div>
+      <button onClick={notify}>Make me a toast</button>
+      <Toaster />
+    </div>
+  );
+};
+```
+
+## Documentation
+
+Find the full API reference on [official documentation](https://react-hot-toast.com/docs).

New alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

56181

increased by143.66%

Number of package files

23

increased by9.52%

Lines of code

1181

increased by92.03%

Number of lines in readme file

56

increased by1766.67%

Worsened metrics

Dev dependency count

4

increased by33.33%

Number of low quality alerts

2

increased by100%

No dependency changes