From 79ae15139a41ab869552e72b2dcb6452bec45666 Mon Sep 17 00:00:00 2001 From: Yunai Date: Sun, 15 Jun 2025 21:44:02 +0900 Subject: [PATCH] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit スタイルが効かないからtableなどで中央よせ、リンク切れなどを修正 --- packages/linejs/README.md | 162 ++++++++++++++++++++++++++------------ 1 file changed, 112 insertions(+), 50 deletions(-) diff --git a/packages/linejs/README.md b/packages/linejs/README.md index e6343f7..5393f62 100644 --- a/packages/linejs/README.md +++ b/packages/linejs/README.md @@ -1,87 +1,149 @@ # LINEJS -[![JSR](https://jsr.io/badges/@evex/linejs)](https://jsr.io/@evex/linejs) -[![JSR Score](https://jsr.io/badges/@evex/linejs/score)](https://jsr.io/@evex/linejs) -[![JSR Scope](https://jsr.io/badges/@evex)](https://jsr.io/@evex) -![release workflow](https://github.com/evex-dev/linejs/actions/workflows/release.yml/badge.svg)\ -[![](https://dcbadge.limes.pink/api/server/evex)](https://discord.gg/evex) - -
- LINEJS -
- -
LINEJS is a JavaScript library for creating a LINE SelfBot.
+> A powerful and modular JavaScript library for creating LINE SelfBots across +> Node.js, Deno, and Bun. https://linejs.evex.land/ + + + + + + + +
+ + Discord Logo
+ Discord + + 		+ + LINEJS Logo + + + + DeepWiki Logo
+ DeepWiki + +
+ +

+ + JSR + + + JSR Score + + + JSR Scope + + Release Status + + Discord + +

--- -#####
❓ Question: Join our [Discord community](https://discord.gg/evex)
+## ℹ️ Information -#####
📚 Documentation: [Check out the full documentation](https://linejs.evex.land)
+- ❓ Question: Join our [Discord community](https://discord.gg/evex) +- 📚 Documentation: [Check out the full documentation](https://linejs.evex.land) +- 🤖 AI Generated Documentation: + [DeepWiki - LINEJS](https://deepwiki.com/evex-dev/linejs) -#####
🤖 AI Generated Documentation: [DeepWiki - LINEJS](https://deepwiki.com/evex-dev/linejs) +## ✨ Features + +- 🔁 LINE SelfBot functionality +- 🔌 Cross-runtime support: Node.js, Deno, Bun +- 💡 TypeScript-first with official typings +- 🧩 Modular packages for full control --- -## Installation +## 📦 Installation -Supports all runtimes (Node.js, Deno, and Bun) and Typescript. +Supports **Node.js**, **Deno**, **Bun**, and **TypeScript** out of the box. -```llvm +```sh +# Node.js npx jsr add @evex/linejs + +# Bun bunx --bun jsr add @evex/linejs + +# Deno deno add @evex/linejs ``` -You can use `git clone` to download the latest development version and use it in Deno. +Want to test the development version? -```llvm +```sh git clone https://github.com/evex-dev/linejs.git cd linejs touch main.js deno run main.js ``` -##### Documentation is [https://linejs.evex.land](https://linejs.evex.land/) -## Browser Support +📚 Full documentation: [https://linejs.evex.land](https://linejs.evex.land) -For now, please use "https://esm.sh/jsr/@evex/linejs". +--- -Example is [here](./example/browser). +## 🌐 Browser Support -## LINEJS Types +Use the following import for browser environments: -Please see [@evex/linejs-types](https://jsr.io/@evex/linejs-types).\ -In short, TypeScript types and enums (such as ReactionType (0, 1, 2, 3), -MessageType, etc.) are provided. +```ts +import { Client } from "https://esm.sh/jsr/@evex/linejs"; +``` -## Provided Packages +See the [browser example](../../example/browser/) for more details. -- client - (@evex/linejs) or (@evex/linejs/client) - - Client - LINE SelfBot Client -- base - (@evex/linejs/base) - - BaseClient - LINE SelfBot API Client -- thrift - (@evex/linejs/thrift) - - Thrift - Thrift read/write -- storage - (@evex/linejs/storage) - - BaseStorage - LINE Client Storage Type - - MemoryStorage - LINE Client Memory Storage - - FileStorage - LINE Client File Storage -- types - (@evex/linejs-types) - - All Types for LINE +--- -## Authors +## 📘 Types -- Owner & Developer: [Piloking](https://github.com/piloking) -- Developer: [EdamAme-x](https://github.com/EdamAme-x) -- Developer: [MocA-Love](https://github.com/MocA-Love) -- Developer: [Hafusun](https://github.com/hafusun) +TypeScript types and enums like `ReactionType`, `MessageType`, etc., are +available in: -## References +🔗 [`@evex/linejs-types`](https://jsr.io/@evex/linejs-types) -- [DeachSword/CHRLINE](https://github.com/DeachSword/CHRLINE) +--- -- [DeachSword/CHRLINE-Thrift](https://github.com/DeachSword/CHRLINE-Thrift/) +## 🧩 Provided Packages + +| Package | Description | +| ---------------------- | ------------------------------------- | +| `@evex/linejs` | LINE SelfBot Client | +| `@evex/linejs/base` | Base LINE API Client | +| `@evex/linejs/thrift` | Thrift serializer/deserializer | +| `@evex/linejs/storage` | Memory & File-based storage for LINE | +| `@evex/linejs-types` | Complete TypeScript typings and enums | + +--- -- [WEDeach/CHRLINE-Patch](https://github.com/WEDeach/CHRLINE-Patch) +## 🧠 Learn More + +- 🤖 AI Documentation: [DeepWiki - LINEJS](https://deepwiki.com/evex-dev/linejs) +- ❓ Questions? [Join our Discord](https://discord.gg/evex) + +--- + +## 👨‍💻 Authors + +- **Owner & Lead Dev**: [Piloking](https://github.com/piloking) +- **Core Developers**: + - [EdamAme-x](https://github.com/EdamAme-x) + - [MocA-Love](https://github.com/MocA-Love) + - [Hafusun](https://github.com/hafusun) + +--- + +## 📚 References & Inspirations + +- [DeachSword/CHRLINE](https://github.com/DeachSword/CHRLINE) +- [CHRLINE-Thrift](https://github.com/DeachSword/CHRLINE-Thrift/) +- [CHRLINE-Patch](https://github.com/WEDeach/CHRLINE-Patch) +- [@discordjs/collection](https://www.npmjs.com/package/@discordjs/collection) + +--- -- [discordjs/collection](https://www.npmjs.com/package/@discordjs/collection) +> Built with ❤️ by the Evex team