UNPKG

twitch-panels

Version:
90 lines (48 loc) 3.52 kB
# TwitchPanels <a href="https://raw.githubusercontent.com/jaid/twitch-panels/master/license.txt"><img src="https://img.shields.io/github/license/jaid/twitch-panels?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor twitch-panels"/></a> <a href="https://actions-badge.atrox.dev/jaid/twitch-panels/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Ftwitch-panels%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/twitch-panels/commits"><img src="https://img.shields.io/github/commits-since/jaid/twitch-panels/v3.5.1?style=flat-square&logo=github" alt="Commits since v3.5.1"/></a> <a href="https://github.com/jaid/twitch-panels/commits"><img src="https://img.shields.io/github/last-commit/jaid/twitch-panels?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/twitch-panels/issues"><img src="https://img.shields.io/github/issues/jaid/twitch-panels?style=flat-square&logo=github" alt="Issues"/></a> <a href="https://npmjs.com/package/twitch-panels"><img src="https://img.shields.io/npm/v/twitch-panels?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/twitch-panels/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/twitch-panels?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/twitch-panels"><img src="https://img.shields.io/npm/dm/twitch-panels?style=flat-square&logo=npm" alt="Downloads"/></a> **Generates Twitch panels.** #### Opinionated This project is tailored to my personal needs and workflows and therefore highly opinionated. Feel free to use it or get inspired by it, but please do not get frustrated if you come across weird features or have difficulties integrating it in your own ecosystem. ## Installation <a href="https://npmjs.com/package/twitch-panels"><img src="https://img.shields.io/badge/npm-twitch--panels-C23039?style=flat-square&logo=npm" alt="twitch-panels on npm"/></a> ```bash npm install --global twitch-panels@^3.5.1 ``` <a href="https://yarnpkg.com/package/twitch-panels"><img src="https://img.shields.io/badge/Yarn-twitch--panels-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="twitch-panels on Yarn"/></a> ```bash yarn global add twitch-panels@^3.5.1 ``` <a href="https://github.com/jaid/twitch-panels/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/twitch--panels-24282e?style=flat-square&logo=github" alt="@jaid/twitch-panels on GitHub Packages"/></a> (if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)) ```bash npm install --global @jaid/twitch-panels@^3.5.1 ``` ## CLI Usage After installing package `twitch-panels` globally, you can use its command line interface. ```bash twitch-panels ``` For usage instructions: ```bash twitch-panels --help ``` ## Development Setting up: ```bash git clone git@github.com:jaid/twitch-panels.git cd twitch-panels npm install ``` Testing: ```bash npm run test:dev ``` Testing in production environment: ```bash npm run test ``` ## License [MIT License](https://raw.githubusercontent.com/jaid/twitch-panels/master/license.txt) Copyright © 2020, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)