keyboard-css - npm Package Compare versions

Comparing version 1.0.0-beta.3 to 1.0.0

package.json

 {
   "name": "keyboard-css",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0",
   "description": "A CSS to show keyboard keys.",
@@ -32,5 +32,7 @@ "main": "css/main.min.css",
     "@commitlint/config-conventional": "^11.0.0",
+    "@qiwi/semantic-release-gh-pages-plugin": "^5.0.1",
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/exec": "^5.0.0",
     "@semantic-release/git": "^9.0.0",
+    "all-contributors-cli": "^6.19.0",
     "autoprefixer": "^10.0.1",
@@ -37,0 +39,0 @@ "browser-sync": "^2.26.13",

README.md

@@ -1,1 +0,65 @@
-# keyboard-css
+
+<!-- markdownlint-disable -->
+<p align="center">
+    <img src="src/copy/logo.png" alt="Keyboard CSS Logo">
+</p>
+
+<p align="center">
+    <i>Show off your keyboard shortcuts with style 🦄.</i>
+</p>
+
+<p align="center">
+    <img src="src/copy/demo.gif" alt="Keyboard CSS Demo">
+</p>
+<!-- markdownlint-restore -->
+
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+![npm](https://img.shields.io/npm/v/keyboard-css)
+[![GitHub license](https://img.shields.io/github/license/shhdharmen/keyboard-css?style=flat-square)](https://github.com/shhdharmen/keyboard-css/blob/main/LICENSE)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+# Keyboard CSS
+
+## Getting Started
+
+Simplest way to use this is through link tag (thanks to <https://unpkg.com/>):
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/keyboard-css/css/main.min.css" />
+```
+
+You can also install it from npm:
+
+```bash
+npm i keyboard-css
+```
+
+## Usage
+
+Visit TBA.
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/shhdharmen"><img src="https://avatars3.githubusercontent.com/u/6831283?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dharmen Shah</b></sub></a><br /><a href="https://github.com/Dharmen Shah/keyboard-css/commits?author=shhdharmen" title="Code">💻</a> <a href="#content-shhdharmen" title="Content">🖋</a> <a href="#design-shhdharmen" title="Design">🎨</a> <a href="https://github.com/Dharmen Shah/keyboard-css/commits?author=shhdharmen" title="Documentation">📖</a> <a href="#ideas-shhdharmen" title="Ideas, Planning, & Feedback">🤔</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

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

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

644471

increased by427.93%

Number of package files

21

increased by61.54%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

66

increased by6500%

Worsened metrics

Dev dependency count

37

increased by5.71%

No dependency changes