Skip to content

This contains tools to help develop and use siren entities.

License

Notifications You must be signed in to change notification settings

BrightspaceHypermediaComponents/siren-sdk

Repository files navigation

@brightspace-hmc/siren-sdk

This contains tools written in ES6 to help develop and use Siren entities

Before adding to this repo, please see: https://desire2learn.atlassian.net/wiki/spaces/TA/pages/4489053073/Draft+Data+API+Guidance+Work-in-progress

Quick start

Options for getting started:

  • Clone the repo: git clone https://github.com/BrightspaceHypermediaComponents/siren-sdk.git.
  • Install with npm: npm i @brightspace-hmc/siren-sdk.

Testing

In a non-administrator powershell:

  • npm run test

Versioning and Releasing

This repo is configured to use incremental-release. Merges to main will trigger minor releases.

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