Skip to content

Commit

Permalink
build(npm): update npm namespace #71
Browse files Browse the repository at this point in the history 
BREAKING CHANGE: This update requires a MAJOR release
as the namespace of the element has been changed.

Changes to be committed:
modified:   README.md
modified:   package.json
  • Loading branch information
@irma-kurnia-phtn @blackfalcon
irma-kurnia-phtn authored and blackfalcon committed Apr 21, 2023
1 parent 770ca23 commit 083a0a6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
14 changes: 5 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For the most up to date information on [UI development browser support](https://

[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-icon/testPublish.yml?branch=master&style=for-the-badge)](https://github.com/AlaskaAirlines/[namespace]-[name]/actions/workflows/testPublish.yml)
[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-icon?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-icon)
[![License](https://img.shields.io/npm/l/@alaskaairux/auro-icon?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-icon?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)

```shell
$ npm i @aurodesignsystem/auro-icon
Expand All @@ -33,7 +33,7 @@ Any update to the Auro Design Tokens will be immediately reflected with browsers
Defining the component dependency within each component that is using the `<auro-icon>` component.

```javascript
import "@alaskaairux/auro-icon";
import "@aurodesignsystem/auro-icon";
```

**Reference component in HTML**
Expand All @@ -51,14 +51,10 @@ In cases where the project is not able to process JS assets, there are pre-proce
Include the following example HTML code in the `<head>` element of your page.

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@alaskaairux/webcorestylesheets@latest/dist/bundled/essentials.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/essentials.css" />

<script src="https://unpkg.com/@alaskaairux/auro-icon@latest/dist/auro-icon__bundled.es5.js" nomodule></script>
<script src="https://unpkg.com/@alaskaairux/auro-icon@latest/dist/auro-icon__bundled.js" type="module"></script>

<script src="https://unpkg.com/@alaskaairux/auro-icon@latest/dist/auro-alaska__bundled.es5.js" nomodule></script>
<script src="https://cdn.jsdelivr.net/npm/@alaskaairux/auro-icon@latest/dist/auro-alaska__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/dist/auro-alaska__bundled.js" type="module"></script>
```

**NOTE:** Be sure to replace `@latest` in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk.
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
" 3. Go to http://localhost:8000",
"================================================================================"
],
"name": "@alaskaairux/auro-icon",
"name": "@aurodesignsystem/auro-icon",
"version": "3.4.3",
"description": "Auro custom auro-icon element",
"author": "Product design and research",
Expand Down

0 comments on commit 083a0a6

Please sign in to comment.