@justeattakeaway/pie-button 0.29.0 → 0.31.0

package/README.md

@@ -11,46 +11,41 @@
 # Table of Contents
 
 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)
    - [Visual Tests](#visual-tests)
 
 
-## `pie-button`
+## pie-button
 
 `pie-button` is a Web Component built using the Lit library. It offers a simple and accessible button component for web applications.
 
 This component can be easily integrated into various frontend frameworks and customized through a set of properties.
 
-## Local development
 
-Install the dependencies. Note that this, and the following commands below, should be run from the **root of the monorepo**:
+## Installation
 
-```bash
-yarn
-```
-
-To build the `pie-button` package, run the following command:
+To install `pie-button` in your application, run the following on your command line:
 
 ```bash
-yarn build --filter=pie-button
-```
+# npm
+$ npm i @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:
+# yarn
+$ yarn add @justeattakeaway/pie-button
+```
 
-```bash
-yarn watch --filter=pie-button
+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).
 
-# in a separate terminal tab, run
-yarn dev --filter=pie-storybook
-```
 
 ### Importing the component
 
@@ -67,11 +62,37 @@ import { PieButton } from '@justeattakeaway/pie-button';
 
 import { PieButton } from '@justeattakeaway/pie-button/dist/react';
 ```
+
+
 ## 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
 
@@ -95,6 +116,7 @@ In your markup or JSX, you can then use these to set the properties for the `pie
 <PieButton size='medium' type='button' variant='primary'>Click me!</PieButton>
 ```
 
+
 ## Slots
 
 | Slot          | Description                                                                                                                        |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-button",
-  "version": "0.29.0",
+  "version": "0.31.0",
   "description": "PIE design system button built using web components",
   "type": "module",
   "main": "dist/index.js",
@@ -25,15 +25,18 @@
     "test:visual": "run -T cross-env-shell PERCY_TOKEN=${PERCY_TOKEN_PIE_BUTTON} percy exec --allowed-hostname cloudfront.net -- npx playwright test -c ./playwright-lit-visual.config.ts",
     "test:visual:ci": "yarn test:visual"
   },
-  "author": "JustEatTakeaway - Design System Web Team",
+  "author": "Just Eat Takeaway.com - Design System Team",
   "license": "Apache-2.0",
   "devDependencies": {
     "@justeat/pie-design-tokens": "5.8.2",
     "@justeattakeaway/pie-components-config": "0.4.0",
-    "@justeattakeaway/pie-css": "0.5.0",
-    "@justeattakeaway/pie-webc-core": "0.9.0"
+    "@justeattakeaway/pie-css": "0.6.0",
+    "@justeattakeaway/pie-webc-core": "0.10.0"
   },
   "volta": {
     "extends": "../../../package.json"
-  }
+  },
+  "sideEffects": [
+    "dist/*.js"
+  ]
 }

package/LICENSE

@@ -1,17 +0,0 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-Copyright (c) Just Eat Takeaway.com
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.