diff --git a/README.md b/README.md index e73c2a8768..09c935efbe 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,16 @@ rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web. +## Publishing @chromaui/rrweb-snapshot + +Chromatic maintains this fork of `rrweb-io/rrweb` solely to publish a version of `rrweb-snapshot` that supports constructable stylesheets for Chromatic e2e capture purposes. + +To distinguish Chromatic-specific builds from those coming from rrweb-io, a `-noAbsolute` label is appended to the end of the package version. If more than one Chromatic build is produced based off of the same rrweb-io version, a number is appended to the end of that label (e.g. `2.0.0-alpha.17-noAbsolute.1`). + +1. In `packages/rrweb-snapshot/package.json`, set the appropriate `-noAbsolute.X` version +2. CD to `packages/rrweb-snapshot` +3. Run `npm publish` + ## Guide [**📚 Read the rrweb guide here. 📚**](./guide.md)