Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md to reflect move to Polymer 3 #33

Merged
merged 4 commits into from
Jan 2, 2020
Merged

Update README.md to reflect move to Polymer 3 #33

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
504f8b1
Update README.md to reflect move to Polymer 3 (changes detailed in as…
Sep 19, 2019
77f2272
Changed npm install instructions to referencing in package.json, chan…
Sep 19, 2019
44b3783
Added forgotten script tags and typo in module name
Sep 20, 2019
7185b4b
adding missing script tag
dlockhart Sep 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# d2l-alert
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/BrightspaceUI/alert)
[![Bower version][bower-image]][bower-url]
[![Build status][ci-image]][ci-url]

[Polymer](https://www.polymer-project.org)-based web component for D2L alerts.
Expand All @@ -9,10 +7,10 @@ For further information on this and other components, refer to [The Brightspace

## Installation

`d2l-alert` can be installed from [Bower][bower-url]:
`d2l-alert` can be installed from through npm by referencing it in your package.json from Github:

```shell
bower install d2l-alert
"d2l-alert": "BrightspaceUI/alert#semver:^4"
```

## Usage
Expand All @@ -30,7 +28,9 @@ Then import the components below that you want to use.
### Alert
```html
<head>
<link rel="import" href="../d2l-alert/d2l-alert.html">
<script type="module">
import 'd2l-alert/d2l-alert.js';
</script>
</head>
```

Expand Down Expand Up @@ -113,7 +113,9 @@ Subtext can be added underneath the main message heading, if more detail is requ
### Toast Alert
```html
<head>
<link rel="import" href="../d2l-alert/d2l-alert-toast.html">
<script type="module">
import 'd2l-alert/d2l-alert-toast.js';
</script>
</head>
```

Expand Down Expand Up @@ -151,19 +153,19 @@ If you don't have it already, install the [Polymer CLI](https://www.polymer-proj
npm install -g polymer-cli
```

To start a [local web server](https://www.polymer-project.org/2.0/docs/tools/polymer-cli-commands#serve) that hosts the demo page and tests:
To start a [local web server](https://www.polymer-project.org/3.0/docs/tools/polymer-cli-commands#serve) that hosts the demo page and tests:

```shell
polymer serve
```

To lint ([eslint](http://eslint.org/) and [Polymer lint](https://www.polymer-project.org/2.0/docs/tools/polymer-cli-commands#lint)):
To lint ([eslint](http://eslint.org/) and [Polymer lint](https://www.polymer-project.org/3.0/docs/tools/polymer-cli-commands#lint)):

```shell
npm run lint
```

To run unit tests locally using [Polymer test](https://www.polymer-project.org/2.0/docs/tools/polymer-cli-commands#tests):
To run unit tests locally using [Polymer test](https://www.polymer-project.org/3.0/docs/tools/polymer-cli-commands#tests):

```shell
npm run test:polymer:local
Expand All @@ -175,8 +177,6 @@ To lint AND run local unit tests:
npm test
```

[bower-url]: http://bower.io/search/?q=d2l-alert
[bower-image]: https://badge.fury.io/bo/d2l-alert.svg
[ci-url]: https://travis-ci.com/BrightspaceUI/alert
[ci-image]: https://travis-ci.com/BrightspaceUI/alert.svg?branch=master

Expand Down