From 761672a9f2d6300561108b95d9ef8c86daea8082 Mon Sep 17 00:00:00 2001 From: Jason Brown <86845131+jasonabrown@users.noreply.github.com> Date: Tue, 27 Jun 2023 09:04:59 -0700 Subject: [PATCH] Update README.md to include Demo usage instructions --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ad19649..b7ee977 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,10 @@ Pass in any additional options using props on the `PSClickWrap` component. You can hook into events using the triggered event callback props described here: ([See documentation on PSClickwrap callback props here](#callback-props)). +#### For Sandboxes and Trial Accounts on the Demo Environment + +For accounts at `app.demo.pactsafe.com`, set the `psScriptUrl` prop as `//vault.demo.pactsafe.io/ps.min.js` to point at the Demo environment. + --- ## Props @@ -112,7 +116,7 @@ You can hook into events using the triggered event callback props described here | `forceScroll` | Disable acceptance until the signer scrolls to the bottom of each contract. | bool | No | Value specified in Ironclad Clickwrap Group's UI | | `groupKey` | Ironclad Clickwrap group key, this is found within the Ironclad Clickwrap Groups configuration. | string | Yes, unless `filter` prop is passed | undefined | | `injectSnippetOnly` | Prop to use if you only want to inject the snippet and do not want the SDK to create and initialize a clickwrap for you. | boolean | No | false | -| `psScriptUrl` | If using a custom (or development) version of the ps.js file, pass the file URL in here. You probably won't need to use this. | string | No | '//vault.pactsafe.io/ps.min.js' | +| `psScriptUrl` | If using a custom (or development) version of the ps.js file, pass the file URL in here. For sandbox/trial accounts on the Demo environment, set the value as '//vault.demo.pactsafe.io/ps.min.js'. | string | No | '//vault.pactsafe.io/ps.min.js' | | `backupScriptUrl` | If using a custom (or development) version of the ps.js file, pass the alternative backup URL in here. Otherwise, this will default to the cloudfront backup provided by the ps.js snippet. This is designed to load if the first script (defined in psScriptURL) fails to load | string | No | ''//d3l1mqnl5xpsuc.cloudfront.net/ps.min.js' | | `renderData` | Object containing the dynamic render data for your contract. [For more information on using dynamic contracts, check out this documentation.](https://developer.pactsafe.com/docs/how-to-use-smart-contracts-with-the-javascript-library) | object | If `dynamic` is set to true | undefined | | `signerIdSelector` | The ID of the `` element that will be used to identify the signer. | string | Yes | Required Value |