@lessondesk/api-client

Lesson Desk API client

Usage no npm install needed!

<script type="module">
  import lessondeskApiClient from 'https://cdn.skypack.dev/@lessondesk/api-client';
</script>

README

@lessondesk/api-client

Build and Publish standard-readme compliant make a pull request lessondesk-code-style

Lesson Desk API client

Table of Contents

Usage

import api from '@lessondesk/api-client'
api.licences.licenceLearnerCount(clientId).then(console.log).catch(console.error)

Install

This project uses node and npm.

$ npm install @lessondesk/api-client
$ # OR
$ yarn add @lessondesk/api-client

Publishing

This module uses the Automated releases for npm packages Github action for releasing when pushed to the master branch.

Versioning

  • If the string "BREAKING CHANGE" is found anywhere in any of the commit messages or descriptions the major version will be incremented.
  • If a commit message begins with the string "feat" then the minor version will be increased. This works for most common commit metadata for feature additions: "feat: new API" and "feature: new API".
  • All other changes will increment the patch version.

FAQS

Contribute

  1. Fork it and create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -am "Add some feature"
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull request