search

Brightspace / polymer-siren-behaviors

utility library for shared behaviors for building siren resource based web-components
Apache License 2.0
0 stars 5 forks source link

readme

d2l-polymer-siren-behaviors

Shared Polymer-based behaviors and modules for implementing and consuming web components.

Installation

d2l-polymer-siren-behaviors can be installed from npm:

npm install d2l-polymer-siren-behaviors

Usage

Import the component or scripts as needed.

<head>
    <link rel="import" href="https://github.com/Brightspace/polymer-siren-behaviors/blob/main/./d2l-polymer-siren-behaviors/store/entity-behavior.html">
    <link rel="import" href="https://github.com/Brightspace/polymer-siren-behaviors/blob/main/./d2l-polymer-siren-behaviors/store/siren-action-behavior.html">
</head>

Versioning and Releasing

This repo is configured to use semantic-release. Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to main.

To learn how to create major releases and release from maintenance branches, refer to the semantic-release GitHub Action documentation.