UNPKG

@rocketspark/domain-checker

Version:
54 lines (46 loc) 2.15 kB
<div align="center"> <img align="center" width="230" src="https://com.rs-cdn.com/images/nxxxm-ciq70/logo/cropped-23/h242.png" /> <h2>Rocketspark Domain Checker</h2> <blockquote>Domain checker for Rocketspark</blockquote> <a href="https://www.npmjs.com/package/@rocketspark/domain-checker"><img src="https://badgen.net/npm/v/@rocketspark/domain-checker?color=blue" alt="npm version"></a> </div> ## 📦 Getting Started Add the following tags to your page ``` <script src="https://cdn.jsdelivr.net/npm/@rocketspark/domain-checker@latest/build/index.js" type="e626c4c4a135bb897f07d239-text/javascript"></script> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@rocketspark/domain-checker@latest/build/css/index.css" type="text/css" media="all" /></div> ``` Then add a div to the page with as follow, setting the locale to be one of UK/NZ/AU/US ``` <div class="rs-domain-check" data-locale="nz"></div> ``` ## 🧑‍💻 Development To develop locally, run the following commands: ``` npm install mprocs ``` This will open a hot dev server on port 9000. ### Using in CMS To use the package in a CMS, start mprocs and put the following into a HTML block: ``` <div class="rs-domain-check" data-locale="nz"></div> <script src="http://localhost:9001/index.js"></script> <link rel="stylesheet" href="http://localhost:9001/css/index.css" type="text/css" media="all"> ``` You should see the domain checker in the CMS. ## 🚀 Releasing Follow the following steps to release a new version of the package 1. Make a PR and merge it to main 2. Actions will make a draft release 3. Review the draft release, remove the (Draft) label and publish the release 4. The package will be published to npm 5. Clear jsDelivr cache (see below) 6. Check it out on the testing page 7. Update the html blocks on rocketspark.com to use the new version ### Clearing jsDelivr cache To clear the jsDelivr cache, go to https://www.jsdelivr.com/tools/purge and enter the following URLs: ``` https://cdn.jsdelivr.net/npm/@rocketspark/domain-checker@latest/build/index.js https://cdn.jsdelivr.net/npm/@rocketspark/domain-checker@latest/build/css/index.css ```