@croct/sdk

Croct SDK for JavaScript.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@croct/sdk
3060.12.32 months ago3 years agoMinified + gzip package size for @croct/sdk in KB

Readme

<a href="https://croct.com">
    <img src="https://cdn.croct.io/brand/logo/repo-icon-green.svg" alt="Croct" height="80" />
</a>
<br />
<strong>SDK JS</strong>
<br />
The official Croct SDK for JavaScript.

<a href="https://www.npmjs.com/package/@croct/sdk"><img alt="Version" src="https://img.shields.io/npm/v/@croct/sdk"/></a>
<a href="https://github.com/croct-tech/sdk-js/actions?query=workflow%3AValidations"><img alt="Build" src="https://github.com/croct-tech/sdk-js/workflows/Validations/badge.svg"/></a>
<a href="https://codeclimate.com/repos/5e7251b3172af05fe9000e27/maintainability"><img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/c44df78a3ed891af11bb/maintainability"/></a>
<a href="https://codeclimate.com/repos/5e7251b3172af05fe9000e27/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/c44df78a3ed891af11bb/test_coverage"/></a>
<br />
<br />
<a href="https://github.com/croct-tech/sdk-js/releases">📦Releases</a>
·
<a href="https://github.com/croct-tech/sdk-js/issues/new?labels=bug&template=bug-report.md">🐞Report Bug</a>
·
<a href="https://github.com/croct-tech/sdk-js/issues/new?labels=enhancement&template=feature-request.md">✨Request Feature</a>

Installation

The preferred way to install the Croct SDK is to use the NPM package manager. Simply enter the following command into a terminal window:
npm install @croct/sdk

Contributing

Contributions to the package are always welcome!
  • Report any bugs or issues on the issue tracker.
  • For major changes, please open an issue first to discuss what you would like to change.
  • Please make sure to update tests as appropriate.

Testing

Before running the test suites, the development dependencies must be installed:
npm install

Then, to run all tests:
npm test

License

This project is released under the MIT License.