@journeeze/sdk 0.1.0-rc.3 → 0.1.0

package/README.md

@@ -1,5 +1,9 @@
 # @journeeze/sdk
 
+[Website & early access](https://journeeze.dev) · [Review board](https://app.journeeze.dev) · [npm](https://www.npmjs.com/package/@journeeze/sdk)
+
+## What is Journeeze?
+
 Journeeze adds in-app help and an opt-in feedback mode to any website or app. Visitors read
 step-by-step guides built from your documented user journeys, and invited reviewers (or signed-in
 users) point at what is unclear. Journeeze groups that feedback and files it as GitHub issues in
@@ -8,6 +12,19 @@ your repository.
 The SDK is a small loader (about 2 KB gzipped). Nothing observes the page until help or the
 feedback mode is switched on, and nothing is captured before the visitor consents.
 
+### Built on Jevitate journeys
+
+Journeeze builds on [Jevitate](https://jevitate.com), the
+[MIT-licensed, open-source browser testing and journey tool](https://github.com/matt-cochran/jevitate).
+Jevitate explores your app, verifies flows in a real browser, and produces replayable journeys
+and step-by-step guides. Journeeze brings those journeys into your live app as help, then adds
+human feedback about what people understood and where they got stuck.
+
+Use Jevitate to author and verify your journeys; connect their `.jevitate/` catalog to Journeeze
+to import guides, review them and publish them for your users. See [Connect GitHub](#connect-github)
+for the catalog connection and CI upload option. You can use Jevitate independently of Journeeze.
+Journeeze and this SDK have their own [service license](#versions-and-license).
+
 **Contents:** [Before you start](#before-you-start) · [Install](#install) ·
 [Environments](#environments-and-apihost) · [Content Security Policy](#content-security-policy) ·
 [Signed-in users](#signed-in-users) · [Privacy and masking](#privacy-and-masking) ·
@@ -15,9 +32,59 @@ feedback mode is switched on, and nothing is captured before the visitor consent
 [GitHub](#connect-github) · [Checklist](#setup-checklist) ·
 [Troubleshooting](#troubleshooting) · [Versions](#versions-and-license)
 
+## Quick start: your first feedback
+
+This package connects your website or web app to the hosted Journeeze service. Installing it
+does not create an account or publish guides. Visit [journeeze.dev](https://journeeze.dev) for
+product information and early access, then get a site key and register your app's origins with
+the Journeeze team ([Before you start](#before-you-start)).
+
+With your production site key:
+
+```sh
+npm install @journeeze/sdk@rc --save-exact
+```
+
+`rc` selects the current release candidate; `--save-exact` pins the resolved version. Commit your
+lockfile for repeatable installs. Add a button to your page:
+
+```html
+<button id="send-feedback" type="button">Send feedback</button>
+```
+
+Run this in your browser entry point after the button exists:
+
+```ts
+import { createJourneeze } from "@journeeze/sdk";
+
+const journeeze = createJourneeze({
+  siteKey: "pk_REPLACE_WITH_YOUR_SITE_KEY",
+  pagePath: "none",
+});
+
+document.querySelector("#send-feedback")?.addEventListener("click", () => {
+  void journeeze.enable();
+});
+```
+
+For a staging site key, also set `apiHost: "https://app.staging.journeeze.dev"`; see
+[Environments](#environments-and-apihost). Mark customer content with `data-jz-mask` before testing.
+
+1. Open your registered app origin and click **Send feedback**.
+2. Accept the consent prompt, select an element and submit a comment. Anonymous visitors can
+   submit feedback; screenshots require [signed-in users](#signed-in-users).
+3. Open your project's [review board](https://app.journeeze.dev) using your owner invite and
+   confirm the report arrived. Triage related reports, group them into clusters, then file a
+   cluster as a GitHub issue once your [GitHub App is connected](#connect-github).
+
+To add guided help, publish a guide and enable help for your site's audience on the board, then
+call `journeeze.enableHelp()`. See [In-app help](#in-app-help) for element anchors and journey context.
+For React or a site without a bundler, use the examples under [Install](#install).
+
 ## Before you start
 
-Journeeze is in early access. The Journeeze team sets up your account. Send them:
+Journeeze is in early access. Start at [journeeze.dev](https://journeeze.dev).
+The Journeeze team sets up your account. Send them:
 
 1. Your organisation and product name.
 2. Every origin the SDK will run on, with scheme, host and port. Example:
@@ -41,11 +108,13 @@ Pick one way. Both load the same code.
 ### npm (bundled apps)
 
 ```sh
-npm install @journeeze/sdk@0.1.0-rc.3 --save-exact
+npm install @journeeze/sdk@rc --save-exact
 ```
 
-Pin an exact version. Release candidates (`-rc.N`) are on the `rc` tag; stable releases on
-`latest`.
+The command resolves `rc` and pins that exact version. To choose a particular release, use
+`npm install @journeeze/sdk@<version> --save-exact`. Release candidates (`-rc.N`) are on the `rc`
+tag; stable releases use `latest`. Check the package's version tags before choosing a channel:
+an unqualified `npm install @journeeze/sdk` can select an older version than `rc`.
 
 **React:**
 
@@ -60,6 +129,7 @@ export function Root() {
       context={{ persona: "owner", journeyId: "billing", journeyStep: "route.billing.pay" }}
       pagePath="none"                        // you pass route ids as journeyStep
     >
+      <HelpButton />
       <App />
     </JourneezeProvider>
   );
@@ -294,7 +364,7 @@ filing.
 **After installing, tell the Journeeze team.** They link the repository to your project. This is
 one step on their side until the board does it for you.
 
-**Your journey catalog.** Journeeze reads the Jevitate catalog in your repository's `.jevitate/`
+**Your journey catalog.** Journeeze reads the [Jevitate](https://jevitate.com) catalog in your repository's `.jevitate/`
 folder (personas, jobs and journeys) on each push. Guides with screenshots and video are imported
 from your approved journeys as drafts. A triager reviews each one on the board (**Journeys**), may
 lightly edit the step text, and publishes it. Only published guides appear in help.

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@journeeze/sdk",
-  "version": "0.1.0-rc.3",
-  "description": "Journeeze feedback mode: a tiny loader that lazy-loads the widget when the mode is switched on.",
+  "version": "0.1.0",
+  "description": "In-app help and opt-in, element-anchored feedback for your web app, with triage and GitHub issues through Journeeze.",
+  "homepage": "https://journeeze.dev",
+  "keywords": [
+    "journeeze",
+    "feedback",
+    "in-app-help",
+    "user-feedback",
+    "github-issues"
+  ],
   "license": "SEE LICENSE IN LICENSE.md",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",