dashcam 0.2.1 → 0.3.0

package/README.md

@@ -1,49 +1,115 @@
 <img src="https://user-images.githubusercontent.com/318295/204898620-922afee0-5415-46a9-a84f-ae6237001bf0.png" height="50" alt="Replayable"/>
 
-# CLI + SDK
+# Replayable API
 
-Why double-back when you can capture it the first time? Playback and share exactly what happened with Replayable's desktop replay buffer.
+Add Replayable to your app or workflow. This package allows you to control the Replayable desktop application from the via CLI SDK.
 
-This package allows you to control the Replayable desktop application from the CLI or SDK.
+> Why double-back when you can capture it the first time? Playback and share exactly what happened with Replayable's desktop replay buffer. 
 
-You can easily embed desktop replays within git commits, pull requests, bug reports, jira tickets, and even within log files.
+You can easily embed desktop replays within git commits, pull requests, bug reports, jira tickets, and even within log files. Desktop replays are a great way to share context behind problems and document the application state within logs, tickets and more.
 
-Desktop replays are a great way to share context behind problems and document the application state within logs, tickets and more.
+Requires that you [install Replayable Desktop](https://replayable.io). Replayable Desktop runs in the background giving you access to a buffer of video.
 
-<a href="https://www.loom.com/share/ea9c2831013a4b5eb996bd47f8178f4e">
-  <p>Capture bugs with replayable. - Watch Video</p>
-  <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/ea9c2831013a4b5eb996bd47f8178f4e-with-play.gif">
-</a>
+## Table of contents
 
-## Quick Setup
+- [Replayable API](#replayable-api)
+    - [Install Replayable Desktop](#install-replayable-desktop)
+- [Examples](#examples)
+  - [Web](#web)
+    - [Setup](#setup)
+    - [HTML Anchor Tag](#html-anchor-tag)
+    - [JS Error Handler](#js-error-handler)
+  - [NodeJS SDK](#nodejs-sdk)
+    - [Setup](#setup)
+    - [Create a Replay](#create-a-replay)
+    - [Error Handler](#error-handler)
+  - [CLI](#cli)
+    - [Setup](#setup)
+    - [Create a Replay](#create-a-replay)
+    - [Return a rich markdown link](#return-a-rich-markdown-link)
+    - [Set a replay title](#set-a-replay-title)
+    - [Attach the last 20 CLI commands to the replay](#attach-the-last-20-cli-commands-to-the-replay)
+    - [Attach a logfile to the replay](#attach-a-logfile-to-the-replay)
+  - [GitHub CLI](#github-cli)
+    - [Create a github issue with a replay in the description](#create-a-github-issue-with-a-replay-in-the-description)
+    - [Create a github pull request with a replay in the description](#create-a-github-pull-request-with-a-replay-in-the-description)
+    - [Append a 30 second replay to a commit](#append-a-30-second-replay-to-a-commit)
+- [Advanced Usage](#advanced-usage)
+  - [Ideas](#ideas)
+
+# Examples
+
+Also see [the examples folder](https://github.com/replayableio/cli/tree/main/examples).
+
+## Web
+
+### Setup
+
+Nothing! The app exposes the protocol to the system natively via `replayable://`.
 
-### Install Replayable Desktop
+### HTML Anchor Tag
+
+```html
+<a href="replayable://replay/create" target="_blank">Create a Replay</a>
+```
+
+### JS Error Handler
+
+```js
+window.onerror = function myErrorHandler() {
+  window.open("replayable://replay/create", "_blank");
+};
+
+setTimeout(() => {
+  throw new Error("Throw makes it go boom!");
+}, 3000);
+```
 
-First, [install Replayable Desktop](https://replayable.io/?betacode=CLIENTRY). Replayable Desktop runs in the background giving you access to a buffer of video.
+## NodeJS SDK
 
-### Install this package
+### Setup
 
 ```sh
-npm install replayable -g
+npm install replayable
 ```
 
-# Table of contents
+### Create a Replay
 
-- [CLI + SDK](#cli--sdk)
-  - [Quick Setup](#quick-setup)
-- [Examples](#examples)
-  - [CLI](#cli)
-  - [GitHub CLI](#github-cli)
-  - [NodeJS SDK](#nodejs-sdk)
-  - [Javascript Integration](#javascript-integration)
-- [Advanced Usage](#advanced-usage)
+```js
+const replayable = require("replayable");
 
-# Examples
+let replay = await replayable.createReplay({
+  title: "My New Replay",
+  description: `This **renders markdown** or plaintext in monospace font.`
+});
+```
+
+### Error Handler
+
+```js
+const replayable = require("replayable");
+
+process.on("uncaughtException", async (err) => {
+  let replay = await replayable.createReplay({
+    title: "uncaughtException",
+    description: err,
+  });
+  console.log("Replayable", replay);
+});
 
-Also see the examples folder.
+setTimeout(() => {
+  throw new Error("Throw makes it go boom!");
+}, 3000);
+```
 
 ## CLI
 
+### Setup
+
+```sh
+npm install replayable -g
+```
+
 ### Create a Replay
 
 ```sh
@@ -109,38 +175,6 @@ $ gh pr create -w -t "Title" -b "`replayable --md`"
 $ git commit -am "`replayable`"
 ```
 
-## NodeJS SDK
-
-```js
-const replayable = require("replayable");
-
-process.on("uncaughtException", async (err) => {
-  let replay = await replayable.createReplay({
-    title: "uncaughtException",
-    description: err,
-  });
-  console.log("Replayable", replay);
-});
-
-setTimeout(() => {
-  throw new Error("Throw makes it go boom!");
-}, 3000);
-```
-
-## Javascript Integration
-
-Note that this example does not require any library to be installed as the app exposes the protocol natively.
-
-```js
-window.onerror = function myErrorHandler() {
-  window.open("replayable://replay/create", "_blank");
-};
-
-setTimeout(() => {
-  throw new Error("Throw makes it go boom!");
-}, 3000);
-```
-
 # Advanced Usage
 
 ```

package/index.js

@@ -6,26 +6,24 @@ const { program } = require("commander");
 let stdin = "";
 
 program
-  .name("replayable")
-  .description(
-    "Upgrade your bug reports, pulls, and readmes with clips from local development"
-  )
-  .version("0.0.9");
+  .name("dashcam")
+  .description("Capture the steps to reproduce every bug.")
+  .version("0.1.0");
 
 program.showHelpAfterError();
 
 program
   .command("create", { isDefault: true })
   .description(
-    "Create a replay and output the resulting url or markdown. Will launch desktop app for local editing before publishing."
+    "Create a clip and output the resulting url or markdown. Will launch desktop app for local editing before publishing."
   )
   .option(
     "-t, --title <string>",
-    "Title of the replay. Automatically generated if not supplied."
+    "Title of the clip. Automatically generated if not supplied."
   )
   .option(
     "-d, --description [text]",
-    "Replay markdown body. This may also be piped in: `cat README.md | replayable create`"
+    "Markdown body. This may also be piped in: `cat README.md | dashcam create`"
   )
   .option("--md", "Returns code for a rich markdown image link.")
   .action(async function (str, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dashcam",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Fix bugs, close pulls, and update your team with desktop instant replay.",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,7 @@
     "prepare": "husky install"
   },
   "bin": {
-    "replayable": "index.js"
+    "dashcam": "index.js"
   },
   "author": "",
   "license": "ISC",