A Magical Web Recorder & Player 🖥 
<p align="center">
<h1 align="center">TimeCat</h1>
<h6 align="center">
A Magical Web Recorder And Player
</h6>
<h6 align="center">

[![GitHub issues](https://img.shields.io/github/issues-raw/oct16/TimeCat)](https://github.com/oct16/TimeCat/issues) ![GitHub last commit](https://img.shields.io/github/last-commit/oct16/timecat) [![npm (tag)](https://img.shields.io/npm/v/timecatjs/latest)](https://www.npmjs.com/package/timecatjs)

<img src="./timecat.gif">
</h6>

## Description

English | [中文](./README.cn.md)

TimeCat is a open source web Page recording tool that generates files are not real video, but can be played like real video, completely restoring the user's actions in the browser.

[🖥 Demo](https://timecatjs.com/demo)

## Documentation

You can find the TimeCat documentation on the [website](https://timecatjs.com). Check out the Introduction page for a quick overview. You can improve it by sending pull requests to this [repository](https://github.com/oct16/TimeCat-Docs)

## Version 

[![npm (tag)](https://img.shields.io/npm/v/timecatjs/latest)](https://www.npmjs.com/package/timecatjs)

#### Browsers Support

| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari |
| - | - | - | - |

## Chrome Plugin

Provides Chrome plugin and supports one-click record and export
| <img width=34 align=top src="https://www.google.com/chrome/static/images/chrome-logo.svg" />| [TimeCat-Chrome](https://chrome.google.com/webstore/detail/timecat-chrome/jgnkkambbdmhfdbdbkljlenddlbplhal) |
|--|--|

## Installation

#### Using [NPM](https://www.npmjs.com/package/timecatjs)
```shell
$ npm i timecatjs -D
```

#### Import in Browser

Add script tags in your browser and use the global variable ``TimeCat``, you can choose the follow CDN:

- <a href="https://www.jsdelivr.com/package/npm/timecatjs"><img align="top" width="100" src="./assets/images/jsdelivr.png"></a>
- <a href="https://unpkg.com/timecatjs"><img align="top" width="100" src="./assets/images/unpkg.png"></a>

## Usage
 - [Quick Start](https://timecatjs.com/docs/)
 - [Step By Step](https://timecatjs.com/docs/step-by-step)

## Contributing

Feel free to dive in! [Open an issue](https://github.com/oct16/TimeCat/issues/new/choose) or submit [PRs](https://github.com/oct16/TimeCat/pulls)   
Standard Readme follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) Code of Conduct

## Contributors

![https://github.com/oct16/TimeCat/graphs/contributors](https://opencollective.com/timecat/contributors.svg?width=890&button=false)

## Donation

<a href="https://opencollective.com/timecat">
<img width=150 src="https://opencollective.com/static/images/opencollectivelogo-footer-n.svg" />
</a>

## License

[GPL-3.0](LICENSE)
