Skip to content

Commit

Permalink
docs(npm): Update npm namespace #70
Browse files Browse the repository at this point in the history
BREAKING CHANGE: This update will redefine the npm namespace
for the auro-header element.

Changes to be committed:
modified:   README.md
modified:   package.json
  • Loading branch information
fajar-apri-alaska authored and blackfalcon committed Apr 18, 2023
1 parent 5aae5b8 commit 246e214
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ For the most up to date information on UI development [browser support](https://

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

```shell
$ npm i @alaskaairux/auro-header
$ npm i @aurodesignsystem/auro-header
```

Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
Expand All @@ -34,7 +34,7 @@ All Auro heading styles are packaged with this component. There is no need to re
Defining the component dependency within each component that is using the `<auro-header>` component.

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

**Reference component in HTML**
Expand All @@ -56,10 +56,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://cdn.jsdelivr.net/npm/@alaskaairux/auro-header@latest/dist/auro-header__bundled.js" type="module"></script>
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-header@latest/dist/auro-header__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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
" 3. Go to http://localhost:3001",
"================================================================================"
],
"name": "@alaskaairux/auro-header",
"name": "@aurodesignsystem/auro-header",
"version": "1.5.4",
"description": "Auro custom auro-header element",
"author": "Product design and research",
Expand Down

0 comments on commit 246e214

Please sign in to comment.