@responsive-ui/bottom-modal - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

package.json

 {
   "name": "@responsive-ui/bottom-modal",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "A bottom modal component of responsive-ui.",
-  "author": "Si3nLoong <[e-mail]>",
-  "homepage": "https://github.com/wetix/responsive-ui#readme",
+  "author": "Si3nLoong <[e-mail]> (https://github.com/si3nloong)",
+  "homepage": "https://github.com/wetix/responsive-ui/blob/master/components/bottom-modal#README.md",
   "license": "MIT",
@@ -16,2 +16,14 @@ "main": "lib/index.cjs",
   },
+  "keywords": [
+    "svelte",
+    "ui-component",
+    "responsive-ui",
+    "bottom-modal",
+    "svelte-bottom-modal"
+  ],
+  "peerDependencies": {
+    "svelte": "^3.29.0",
+    "svelte-preprocess": "^4.5.0",
+    "typescript": "^4.0.0"
+  },
   "directories": {
@@ -36,6 +48,6 @@ "lib": "lib",
   },
-  "gitHead": "e740bd4aded5d1d82f70f790742b463b46be5297",
+  "gitHead": "51581b929651667bc2acafd8879394ac7a10fa40",
   "dependencies": {
-    "@responsive-ui/icon": "^0.5.0"
+    "@responsive-ui/icon": "^0.5.1"
   }
 }

README.md

@@ -1,11 +0,67 @@
-# `bottom-modal`
+# @responsive-ui/bottom-modal
 
-> TODO: description
+> A bottom bar component of responsive-ui.
 
-## Usage
+<p>
 
+[![npm](https://img.shields.io/npm/v/@responsive-ui/bottom-modal.svg)](https://www.npmjs.com/package/@responsive-ui/bottom-modal)
+[![download](https://img.shields.io/npm/dw/@responsive-ui/bottom-modal.svg)](https://www.npmjs.com/package/@responsive-ui/bottom-modal)
+[![Bundle Size](https://badgen.net/bundlephobia/minzip/%40responsive-ui%2Fbottom-modal)](https://bundlephobia.com/result?p=@responsive-ui/bottom-modal)
+[![LICENCE](https://img.shields.io/github/license/wetix/responsive-ui)](https://github.com/wetix/responsive-ui/blob/master/LICENSE)
+
+</p>
+
+## Install
+
+```console
+npm install @responsive-ui/bottom-modal
 ```
-const bottomModal = require('bottom-modal');
 
-// TODO: DEMONSTRATE API
+or
+
+```console
+yarn add @responsive-ui/bottom-modal
 ```
+
+## Look and Feel
+
+<img src="https://user-images.githubusercontent.com/28108597/104027204-01e30700-5202-11eb-81ec-5573fd844af3.png"
+alt="@responsive-ui/bottom-modal" />
+
+## Properties, Events & Slots
+
+```ts
+interface BottomBarProps {
+  class?: string;
+  style?: string;
+}
+
+declare class BottomBar extends SvelteComponentTyped<BottomBarProps> {}
+```
+
+## Example
+
+```svelte
+<script>
+  import BottomBar from '@responsive-ui/bottom-modal';
+</script>
+
+<BottomBar>Bottom Bar</BottomBar>
+```
+
+[Try it yourself in Svelte Repl](https://svelte.dev/repl/00bbb3aaea2d43fcaca9e8ba9dfef718?version=3.31.2)
+
+## Sponsors
+
+<img src="https://asset.wetix.my/images/logo/wetix.png" alt="WeTix" width="240px">
+
+## License
+
+[@responsive-ui/bottom-modal](https://github.com/wetix/responsive-ui/tree/master/components/bottom-modal) is 100% free and open-source, under the [MIT license](https://github.com/wetix/responsive-ui/blob/master/LICENSE).
+
+## Big Thanks To
+
+Thanks to these awesome companies for their support of Open Source developers ❤
+
+[![GitHub](https://jstools.dev/img/badges/github.svg)](https://github.com/open-source)
+[![NPM](https://jstools.dev/img/badges/npm.svg)](https://www.npmjs.com/)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

100051

increased by2.17%

Number of lines in readme file

68

increased by466.67%

Worsened metrics

Dependency count

4

increased by300%

Number of low quality alerts

2

increased by100%

Dependency changes

• Updated@responsive-ui/icon@^0.5.1