@justeattakeaway/pie-button - npm Package Compare versions

Comparing version 0.30.0 to 0.31.0

package.json

 {
   "name": "@justeattakeaway/pie-button",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "description": "PIE design system button built using web components",
@@ -33,4 +33,4 @@ "type": "module",
     "@justeattakeaway/pie-components-config": "0.4.0",
-    "@justeattakeaway/pie-css": "0.5.1",
-    "@justeattakeaway/pie-webc-core": "0.9.1"
+    "@justeattakeaway/pie-css": "0.6.0",
+    "@justeattakeaway/pie-webc-core": "0.10.0"
   },
@@ -37,0 +37,0 @@ "volta": {

README.md

@@ -14,10 +14,12 @@ <p align="center">
 1. [Introduction](#pie-button)
-2. [Local Development](#local-development)
-3. [Props](#props)
+2. [Installation](#installation)
+3. [Importing the component](#importing-the-component)
 4. [Peer Dependencies](#peer-dependencies)
-5. [Events](#events)
+5. [Local Development](#local-development)
+6. [Props](#props)
+7. [Events](#events)
    - [HTML example](#html)
    - [Vue example (using Nuxt 3)](#vue-templates-using-nuxt-3)
    - [React example (using Next 13)](#react-templates-using-next-13)
-6. [Testing](#testing)
+8. [Testing](#testing)
    - [Browser Tests](#browser-tests)
@@ -27,3 +29,3 @@ - [Visual Tests](#visual-tests)
 
-## `pie-button`
+## pie-button
 
@@ -34,25 +36,18 @@ `pie-button` is a Web Component built using the Lit library. It offers a simple and accessible button component for web applications.
 
-## Local development
 
-Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**:
+## Installation
 
+To install `pie-button` in your application, run the following on your command line:
+
 ```bash
-yarn
-```
+# npm
+$ npm i @justeattakeaway/pie-button
 
-To build the `pie-button` package, run the following command:
-
-```bash
-yarn build --filter=pie-button
+# yarn
+$ yarn add @justeattakeaway/pie-button
 ```
 
-If you'd like to develop using the component storybook, then you should build the component in `watch` mode, and run storybook in a separate terminal tab:
+For full information on using PIE components as part of an application, check out the [Getting Started Guide](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components).
 
-```bash
-yarn watch --filter=pie-button
 
-# in a separate terminal tab, run
-yarn dev --filter=pie-storybook
-```
-
 ### Importing the component
@@ -73,8 +68,34 @@
 ```
+
+
 ## Peer Dependencies
 
-> **Note**
-> Before using `@justeattakeaway/pie-button`, please make sure you have the following peer dependencies installed in your project:
-> - `react` (for integration with React apps only)
+> [!IMPORTANT]
+> When using `pie-button`, you will also need to include a couple of dependencies to ensure the component renders as expected. See [the PIE Wiki for more information and how to include these in your application](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components#expected-dependencies).
 
+
+## Local development
+
+Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**:
+
+```bash
+yarn
+```
+
+To build the `pie-button` package, run the following command:
+
+```bash
+yarn build --filter=pie-button
+```
+
+If you'd like to develop using the component storybook, then you should build the component in `watch` mode, and run storybook in a separate terminal tab:
+
+```bash
+yarn watch --filter=pie-button
+
+# in a separate terminal tab, run
+yarn dev --filter=pie-storybook
+```
+
+
 ## Props
@@ -102,2 +123,3 @@
 
+
 ## Slots
@@ -104,0 +126,0 @@

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

Improved metrics

Total package byte prevSize

45291

increased by0.02%

Number of lines in readme file

204

increased by12.09%

Worsened metrics

Number of package files

10

decreased by-9.09%

No dependency changes