UNPKG

jaidbot

Version:

Personal chat bot for my Twitch stream.

104 lines (63 loc) 3.99 kB
# Jaidbot <a href="https://raw.githubusercontent.com/jaid/jaidbot/master/license.txt"><img src="https://img.shields.io/github/license/jaid/jaidbot?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 jaidbot"/></a> <a href="https://actions-badge.atrox.dev/jaid/jaidbot/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fjaidbot%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/jaidbot/commits"><img src="https://img.shields.io/github/commits-since/jaid/jaidbot/v6.4.1?style=flat-square&logo=github" alt="Commits since v6.4.1"/></a> <a href="https://github.com/jaid/jaidbot/commits"><img src="https://img.shields.io/github/last-commit/jaid/jaidbot?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/jaidbot/issues"><img src="https://img.shields.io/github/issues/jaid/jaidbot?style=flat-square&logo=github" alt="Issues"/></a> <a href="https://npmjs.com/package/jaidbot"><img src="https://img.shields.io/npm/v/jaidbot?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/jaidbot/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/jaidbot?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/jaidbot"><img src="https://img.shields.io/npm/dm/jaidbot?style=flat-square&logo=npm" alt="Downloads"/></a> **Personal chat bot for my Twitch stream.** ## Installation <a href="https://npmjs.com/package/jaidbot"><img src="https://img.shields.io/badge/npm-jaidbot-C23039?style=flat-square&logo=npm" alt="jaidbot on npm"/></a> ```bash npm install --global jaidbot@^6.4.1 ``` <a href="https://yarnpkg.com/package/jaidbot"><img src="https://img.shields.io/badge/Yarn-jaidbot-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="jaidbot on Yarn"/></a> ```bash yarn global add jaidbot@^6.4.1 ``` <a href="https://github.com/jaid/jaidbot/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/jaidbot-24282e?style=flat-square&logo=github" alt="@jaid/jaidbot 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/jaidbot@^6.4.1 ``` ## CLI Usage After installing package `jaidbot` globally, you can use its command line interface. ```bash jaidbot ``` For usage instructions: ```bash jaidbot --help ``` ## Development Setting up: ```bash git clone git@github.com:jaid/jaidbot.git cd jaidbot npm install ``` Testing: ```bash npm run test:dev ``` Testing in production environment: ```bash npm run test ``` ## License ```text MIT License Copyright © 2020, Jaid <jaid.jsx@gmail.com> (github.com/jaid) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ```