From 9667a9ae460d35853a14d498974c6ee5b2028fa0 Mon Sep 17 00:00:00 2001 From: Yanzhen Yu Date: Wed, 1 Apr 2026 12:00:00 +0800 Subject: [PATCH] update README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9c46dd60..765210fd 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://travis-ci.org/rrweb-io/rrweb-snapshot.svg?branch=master)](https://travis-ci.org/rrweb-io/rrweb-snapshot) Snapshot the DOM into a stateful and serializable data structure. -Also provide the ability to rebuild the DOM via snapshot. +Also, provide the ability to rebuild the DOM via snapshot. ## API @@ -13,22 +13,22 @@ This module export following methods: `snapshot` will traverse the DOM and return a stateful and serializable data structure which can represent the current DOM **view**. -There are serveral things will be done during snapshot: +There are several things will be done during snapshot: 1. Inline some DOM states into HTML attributes, e.g, HTMLInputElement's value. -2. Turn script tags into noscript tags to avoid scripts being executed. +2. Turn script tags into `noscript` tags to avoid scripts being executed. 3. Try to inline stylesheets to make sure local stylesheets can be used. -4. Make relative paths in href, src, css to be absolute paths. -5. Give a id to each Node, and return the id node map when snapshot finished. +4. Make relative paths in href, src, CSS to be absolute paths. +5. Give an id to each Node, and return the id node map when snapshot finished. #### rebuild `rebuild` will build the DOM according to the taken snapshot. -There are serveral things will be done during rebuild: +There are several things will be done during rebuild: -1. Add data-rrid attribute if Node is an Element. -2. Create some extra DOM node like text node to place inline css and some states. +1. Add data-rrid attribute if the Node is an Element. +2. Create some extra DOM node like text node to place inline CSS and some states. 3. Add data-extra-child-index attribute if Node has some extra child DOM. #### serializeNodeWithId