diff --git a/README.md b/README.md index 74cbb1c..e3e9d26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # StartOS activate-license template -A drop-in folder that adds Bitcoin-native licensing to your existing Start9 +A drop-in folder that adds Keysat licensing to your existing Start9 (StartOS 0.4.0.x) package. Your buyers get: - **"Buy license"** — pay with Bitcoin/Lightning on your BTCPay, never copy/paste the key. Optional discount/referral code field. @@ -29,12 +29,15 @@ startos/licensing/ ← config, store shape, runtime gate startos/actions/ ← five actions (merge with your existing actions/) ``` -Add the SDK to your package's `package.json`: +Add the SDK to your package's `package.json`. The TypeScript SDK isn't yet +published on npm; install from the GitHub repo directly (the repo is public): ```bash -npm install @keysat/licensing-client +npm install github:keysat-xyz/keysat-client-ts ``` +Once the SDK is published to npm, this becomes `npm install @keysat/licensing-client`. + ## Wire-up, in 4 edits ### 1. Fill in `startos/licensing/config.ts` @@ -71,6 +74,7 @@ export const actions = sdk.Actions.of() .addAction(licensingActions.activateLicense) .addAction(licensingActions.buyLicense) .addAction(licensingActions.finishLicensePurchase) + .addAction(licensingActions.redeemFreeLicense) .addAction(licensingActions.checkLicense) .addAction(licensingActions.deactivateLicense) ```