alihan/headless-recorder
1
0
Fork 0
mirror of https://github.com/checkly/headless-recorder.git synced 2021-07-28 02:03:42 +03:00
Code Issues Projects Releases Wiki Activity

chore: add break lines to readme

Browse Source
This commit is contained in:
Nacho Anaya
2021-02-03 01:12:22 -03:00
committed by GitHub
parent 47b43f0475
commit e68e353389
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -28,6 +28,8 @@ Don't forget to check out our sister project [theheadless.dev](https://theheadle
This project builds on existing open source projects (see [Credits](#-credits)) but adds extensibility, configurability and a smoother UI. For more information, please see our [documentation](https://www.checklyhq.com/docs/headless-recorder/).
<br>
## 🏗️ What you can do?
- Records clicks and type events.
@@ -40,6 +42,8 @@ This project builds on existing open source projects (see [Credits](#-credits))
> Note: we only record certain events. See `dom-events-to-record.js` in the code-generator folder for which events. This collection will be expanded in future releases.
<br>
## 🔧 How to use?
- Click the icon and hit Record.
@@ -48,6 +52,8 @@ This project builds on existing open source projects (see [Credits](#-credits))
- Wait for full page load on each navigation. The icon will switch from ![](src/images/icon_rec.png) to ![](src/images/icon_wait.png) to indicate it is ready for more input from you.
- Click Pause when you want to navigate without recording anything. Hit Resume to continue recording.
<br>
## 🖥️ Development
1. Open the terminal and clone the project: `$ git clone https://github.com/checkly/headless-recorder.git`
@@ -57,6 +63,8 @@ This project builds on existing open source projects (see [Credits](#-credits))
1. Make sure 'Developer mode' is enabled
1. Click "Load unpacked extension" button, browse the `headless-recorder/build` directory and select it
<br>
## 🚀 Release
1. Bump versions in `package.json` and `manifest.json`
@@ -67,10 +75,14 @@ This project builds on existing open source projects (see [Credits](#-credits))
> ⚠️ Make sure all issues associated with the new version are linked to a milestone
with the name of the tag.
<br>
## 🙏 Credits
Headless recorder is the spiritual successor & love child of segment.io's [Daydream](https://github.com/segmentio/daydream) and [ui recorder](https://github.com/yguan/ui-recorder).
<br>
## 📄 License
[Apache 2](https://github.com/checkly/headless-recorder/blob/master/LICENSE)