Skip to content

Commit

Permalink
🔖 Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
d2n0s4ur committed Feb 13, 2024
1 parent fecbff4 commit c98fb74
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 5 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Chzzk Chat Crawler
# Chzzk-Chat library

![Test workflow status](https://github.com/d2n0s4ur/chzzk-chat/workflows/Test/badge.svg)
[![Npm Version](https://img.shields.io/npm/v/@d2n0s4ur/chzzk-chat.svg?style=flat)](https://www.npmjs.com/package/@d2n0s4ur/chzzk-chat)
[![Downloads](https://img.shields.io/npm/dm/@d2n0s4ur/chzzk-chat.svg?style=flat)](https://www.npmjs.com/package/@d2n0s4ur/chzzk-chat)
[![Issues](https://img.shields.io/github/issues/d2n0s4ur/chzzk-chat.svg?style=flat)](https://github.com/d2n0s4ur/chzzk-chat)
[![Node version](https://img.shields.io/node/v/@d2n0s4ur/chzzk-chat)](https://www.npmjs.com/package/@d2n0s4ur/chzzk-chat)



<img alt="chzzk_logo" src="./img/chzzk_logo.svg" style="width: 40%">
Expand All @@ -10,10 +17,18 @@ Javascript를 통해 치지직 채팅을 크롤링하는 코드입니다.

## Node

### NPM
```bash
$ npm install @d2n0s4ur/chzzk-chat
```

### Yarn
```bash
$ yarn add @d2n0s4ur/chzzk-chat
```

## Usage

```typescript
import { ChzzkChat } from "@d2n0s4ur/chzzk-chat";

Expand All @@ -33,4 +48,4 @@ const messageHandler: messageHandler = (
};

chzzkChat.addMessageHandler(messageHandler);
```
```
10 changes: 7 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@d2n0s4ur/chzzk-chat",
"version": "1.1.0",
"description": "chzzk chat crawler",
"version": "1.1.1",
"description": "chzzk-chat: 자바스크립트 개발자를 위한 chzzk 채팅 비공식 라이브러리",
"main": "dist/cjs/index.js",
"module": "dist/mjs/index.js",
"types": "dist/index.d.ts",
Expand All @@ -23,9 +23,13 @@
"chzzk",
"chat",
"crawler",
"javascript",
"typescript",
"치지직",
"채팅",
"크롤링"
"크롤링",
"자바스크립트",
"타입스크립트"
],
"author": "d2n0s4ur",
"license": "ISC",
Expand Down

0 comments on commit c98fb74

Please sign in to comment.