Skip to content

Commit

Permalink
Adding github action.yml, dependabot and readme update
Browse files Browse the repository at this point in the history
prasanaworld committed Jun 2, 2024
1 parent 037d714 commit 497c4ed
Showing 4 changed files with 63 additions and 13 deletions.
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'weekly'

- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'weekly'
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Puppeteer-screen-recorder CI

on: [workflow_dispatch, push, pull_request]

jobs:
build:
runs-on: ${{ matrix.os }}

strategy:
matrix:
node-version: [20.6.1]
os: [macos-latest, windows-latest, ubuntu-latest]

steps:
- uses: actions/checkout@v4.1.6
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@4
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm run build
- run: npm run test
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
# <img alt="puppeteer screen recorder logo" width="128px" src="https://github.com/prasanaworld/puppeteer-screen-recorder/blob/main/asserts/puppeteer-screen-recorder.png" /> puppeteer-screen-recorder

A puppeteer Plugin that uses the native [chrome devtool protocol](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-startScreencast) for capturing video frame by frame. Also supports an option to follow pages that are opened by the current page object. [Check out API Docs](https://prasanaworld.github.io/puppeteer-screen-recorder/classes/puppeteerscreenrecorder.html).
A puppeteer Plugin that uses the native [chrome devtool protocol](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-startScreencast) for capturing video frame by frame. Also supports an option to follow pages that are opened by the current page object.
[Check out API Docs](https://prasanaworld.github.io/puppeteer-screen-recorder/classes/puppeteerscreenrecorder.html).

![Website](https://img.shields.io/website?url=https%3A%2F%2Fprasanaworld.github.io%2Fpuppeteer-screen-recorder%2Fclasses%2Fpuppeteerscreenrecorder.html&style=plastic&logo=website&label=Documentation) ![Discord](https://img.shields.io/discord/1246821801120632902?style=plastic&logo=discord&label=Join%20Our%20Discord%20Server&link=https%3A%2F%2Fdiscord.com%2Fchannels%2F1246821801120632902%2F1246821801120632905)

[![NPM](https://nodei.co/npm/puppeteer-screen-recorder.png)](https://npmjs.org/package/puppeteer-screen-recorder)

![GitHub](https://img.shields.io/github/license/prasanaworld/puppeteer-screen-recorder)
![GitHub Sponsors](https://img.shields.io/github/sponsors/prasanaworld)
![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/puppeteer-screen-recorder?label=Open%20Collective%20sponsors)
![GitHub](https://img.shields.io/github/license/prasanaworld/puppeteer-screen-recorder) ![GitHub Sponsors](https://img.shields.io/github/sponsors/prasanaworld?label=Github%20Sponsours) ![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/puppeteer-screen-recorder?label=Open%20Collective%20sponsors)

![GitHub package.json version](https://img.shields.io/github/package-json/v/prasanaworld/puppeteer-screen-recorder)
![GitHub top language](https://img.shields.io/github/languages/top/prasanaworld/puppeteer-screen-recorder)
![npm](https://img.shields.io/npm/dt/puppeteer-screen-recorder)
![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/puppeteer-screen-recorder)
![GitHub package.json version](https://img.shields.io/github/package-json/v/prasanaworld/puppeteer-screen-recorder) ![GitHub top language](https://img.shields.io/github/languages/top/prasanaworld/puppeteer-screen-recorder) ![npm](https://img.shields.io/npm/dt/puppeteer-screen-recorder) ![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/puppeteer-screen-recorder)

![GitHub forks](https://img.shields.io/github/forks/prasanaworld/puppeteer-screen-recorder?style=social)
![GitHub Repo stars](https://img.shields.io/github/stars/prasanaworld/puppeteer-screen-recorder?style=social)
![GitHub watchers](https://img.shields.io/github/watchers/prasanaworld/puppeteer-screen-recorder?style=social)
![Twitter Follow](https://img.shields.io/twitter/follow/prasanaworld?style=social)
![GitHub forks](https://img.shields.io/github/forks/prasanaworld/puppeteer-screen-recorder?style=social) ![GitHub Repo stars](https://img.shields.io/github/stars/prasanaworld/puppeteer-screen-recorder?style=social) ![GitHub watchers](https://img.shields.io/github/watchers/prasanaworld/puppeteer-screen-recorder?style=social) ![Twitter Follow](https://img.shields.io/twitter/follow/prasanaworld?style=social)

<a href="https://github.com/prasanaworld/puppeteer-screen-recorder/issues/new">Add Feature Request</a>

19 changes: 18 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -17,6 +17,24 @@
"sponsor": {
"url": "https://opencollective.com/puppeteer-screen-recorder"
},
"funding": [
{
"type": "individual",
"url": "https://github.com/sponsors/prasanaworld/dashboard/tiers?frequency=one-time"
},
{
"type": "individual",
"url": "https://opencollective.com/puppeteer-screen-recorder"
},
{
"type": "corporate",
"url": "https://github.com/sponsors/prasanaworld/dashboard/tiers"
},
{
"type": "corporate",
"url": "https://opencollective.com/puppeteer-screen-recorder"
}
],
"homepage": "https://prasanaworld.github.io/puppeteer-screen-recorder/",
"license": "MIT",
"keywords": [
@@ -78,7 +96,6 @@
"cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
"doc": "run-s doc:html && open-cli build/docs/index.html",
"doc:html": "typedoc src/ --exclude **/*.spec.ts --excludePrivate --target ES6 --mode file --out build/docs",
"doc:json": "typedoc src/ --exclude **/*.spec.ts --excludePrivate --target ES6 --mode file --json build/docs/typedoc.json",
"doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
"version": "standard-version",
"reset-hard": "git clean -dfx && npm i",

0 comments on commit 497c4ed

Please sign in to comment.