UNPKG

@croct/plug

Version:

A fully-featured devkit for building natively personalized applications.

57 lines (42 loc) 2.77 kB
<p align="center"> <a href="https://croct.com" target="_blank"> <picture> <source media="(min-width: 769px) and (prefers-color-scheme: light)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light.svg"> <source media="(min-width: 769px) and (prefers-color-scheme: dark)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-dark.svg"> <source media="(max-width: 768px) and (prefers-color-scheme: dark)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-dark-mobile.svg"> <source media="(max-width: 768px) and (prefers-color-scheme: light)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light-mobile.svg"> <img src="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light-mobile.svg" alt="Croct JavaScript SDK" title="Croct JavaScript SDK" width="100%"> </picture> </a> <br/> <strong>Croct JavaScript SDK</strong><br/> Bring dynamic, personalized content natively into your applications. </p> <div align="center"> <strong>📘 <a href="https://docs.croct.com/reference/sdk/javascript/installation">Quick start &rarr;</a></strong> </div> <br/> <p align="center"> <a href="https://www.npmjs.com/package/@croct/plug"><img alt="Version" src="https://img.shields.io/npm/v/@croct/plug"/></a> <img alt="Gzipped bundle size" src="https://img.badgesize.io/https:/cdn.croct.io/js/v1/lib/plug.js?style=flat&compression=gzip" /> <a href="https://codeclimate.com/repos/5e7251a86589d75edf000f9e/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/2288af031dccbec256d9/test_coverage"/></a> </p> ## Introduction Croct is a headless CMS that helps you manage content, run AB tests, and personalize experiences without the hassle of complex integrations. ## Installation Run this command to install the SDK: ```sh npm install @croct/plug ``` See our [quick start guide](https://docs.croct.com/reference/sdk/javascript/installation) for more details. ## Documentation Visit our [official documentation](https://docs.croct.com/reference/sdk/javascript/installation). ## Support Join our official [Slack channel](https://croct.link/community) to get help from the Croct team and other developers. ## Contribution Contributions are always welcome! - Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/plug-js/issues). - For major changes, please [open an issue](https://github.com/croct-tech/plug-js/issues) first to discuss what you would like to change. - Please make sure to update tests as appropriate. Run tests with `npm test`. ## License This library is licensed under the [MIT license](LICENSE).