Skip to content

Commit

Permalink
updates README & keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
retconned committed Sep 14, 2024
1 parent 3f7807e commit b585d99
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 4 deletions.
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,48 @@
**@retconned/kickjs**
![Version](https://img.shields.io/npm/v/@retconned/kick-js?label=Version)
![License](https://img.shields.io/npm/l/@retconned/kick-js?label=License)

A demo package for Total TypeScript.
❇️ **@retconned/kick-js**

## **What is kick-js**

**kick-js** is a TypeScript-based library for [kick.com](https://kick.com)'s chat system. It provides a simple interface that allows developers to build chat bots and other chat-related applications.

### :construction: This is a new rewrite of the kick-js library, it is not compatible with the previous version. :construction:

## Features :rocket:

- Supports reading & writing to Kick.com chat.
- Moderation actions (ban, slowmode).
- Written in TypeScript.

## Installation :package:

Install the @retconned/kick-js package using the following command:

```sh
npm install @retconned/kick-js
```

## Example code :computer:

```ts
import { createClient } from "@retconned/kick-js";
import "dotenv/config";

const client = createClient("xqc", { logger: true });

client.on("ready", () => {
console.log(`Bot ready & logged into ${client.user?.tag}!`);
});

client.login({ process.env.TOKEN, process.env.COOKIES });

client.on("ChatMessage", async (message) => {
console.log(`${message.sender.username}: ${message.content}`);
}
});
```

## Disclaimer :warning:

@retconned/kick-js is not affiliated with or endorsed by [Kick.com](https://kick.com). It is an independent tool created to facilitate making moderation bots & other chat-related applications.
10 changes: 8 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@
"version": "0.1.2",
"description": "A typescript bot interface for kick.com",
"keywords": [
"demo",
"typescript"
"Kick.com",
"Kick Streaming",
"Livestream",
"Kick Chat",
"Kick Bot",
"Kick Api",
"Kick Api Wrapper",
"Kick library"
],
"homepage": "https://github.com/retconned/kick-js",
"bugs": {
Expand Down

0 comments on commit b585d99

Please sign in to comment.