# TimeCat

**Repository Path**: jaawu/TimeCat

## Basic Information

- **Project Name**: TimeCat
- **Description**: A Magical Web Recorder 🖥 (WIP) 
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-17
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
<h1 align="center">TimeCat</h1>
<h6 align="center">
A Magical Web Recorder 🖥 网页录屏器
</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)
<h6>

## 项目简介

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

TimeCat 是一个网页录屏工具，利用独特的录制方式与算法，提供超高性能与高压缩比的网页无损视频录制与回放

[🖥 DEMO](https://timecat.xxxxoo.com/) Chrome浏览器

## Milestone
    08.20 Prerelease V1.2.0-alpha
    07.20 Support Iframe (V1.1.0)
    06.07 Support Audio
    05.24 Released V1.0.0
    04.26 Live Mode    
    03.31 Chrome Plugin Released
    02.12 Departure

## 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

提供了Chrome插件并支持一键录制导出

| <img src="articles/images/logo.png" width="30">| [TimeCat-Chrome](https://chrome.google.com/webstore/detail/timecat-chrome/jgnkkambbdmhfdbdbkljlenddlbplhal?hl=en&authuser=0) |
|--|--|

## 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``

- **jsDelivr**
  - https://cdn.jsdelivr.net/npm/timecatjs
  - https://cdn.jsdelivr.net/npm/@timecat/recorder
  - https://cdn.jsdelivr.net/npm/@timecat/player
- **UNPKG**
  - https://unpkg.com/timecatjs
  - https://unpkg.com/@timecat/recorder
  - https://unpkg.com/@timecat/player

## Usage
 - [快速开始](articles/quick-start.md)

## Articles
 - [录屏原理简介](articles/technology.cn.md)
 - [TimeCat 入门：我们的第一个应用](articles/record-and-replay.md)

## 交流与建议

开发中若遇到任何问题或有任何建议   
欢迎联系 [@oct16](https://github.com/oct16) 交流与讨论   
<img src="articles/images/contactQR.jpg" width="150"/>

</a>

## 贡献项目
非常欢迎您的加入    
[提一个 Issue](https://github.com/oct16/TimeCat/issues/new) 或者提交一个 Pull Request
标准 Readme 遵循 [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)  行为规范

## Contributors

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

## 捐助项目

##### WeChat Pay and Alipay
<img src="articles/images/donate.png" width="180" />

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

## 使用许可
[GPL-3.0](LICENSE)