chore: add readme

Author: sysnote8main

README.md

@@ -0,0 +1,71 @@
+
+# README
+
+README language: 日本語 (baseline) | [English](README_en.md)
+
+---
+---
+
+## 日本語
+
+概要
+
+GraceStopAnnouncer は、Java 製の Minecraft サーバープラグインで、Graceful shutdown（優雅な停止）時に接続保持や通知を行うための機能を提供します。Bukkit/Spigot と Velocity の両方をサポートしています。
+
+主な用途:
+
+- サーバー停止時に接続を保持してクライアントの切断を遅延させる
+- 外部サービス（例: ロードバランサやオーケストレーションツール）からの停止通知を受け取り、プラグイン側で適切に処理する
+
+このリポジトリは以下の主要パッケージを含みます:
+
+- `src/main/java/net/azisaba/gracestopannouncer/bukkit/` — Bukkit 用アダプタとプラグイン本体
+- `src/main/java/net/azisaba/gracestopannouncer/velocity/` — Velocity 用アダプタとプラグイン本体
+- `src/main/java/net/azisaba/gracestopannouncer/core/` — 共通コアロジック
+- `src/main/resources/` — デフォルト設定ファイル（`config.yml`, `velocity-config.yml` など）
+
+## 特徴
+
+- Bukkit（Spigot/Paper）と Velocity の両対応
+- 停止通知の受信ハンドラ（`PreStopHookReceiver` 等）
+- 接続をホールドするハンドラ（`HoldConnectionHandler`）
+- カスタムメッセージフォーマッタ（`MessageFormatter`）
+
+## 要件
+
+- Java 8 以上
+- Maven（`pom.xml` がリポジトリに含まれています）
+
+## ビルド方法
+
+プロジェクトのルートで以下のコマンドを実行してビルドします（macOS/zsh の場合）:
+
+```bash
+mvn clean package
+```
+
+ビルドに成功すると、`target/GraceStopAnnouncer.jar` と `target/original-GraceStopAnnouncer.jar` が生成されます。
+
+## 設定
+
+デフォルト設定ファイルは `src/main/resources/` にあります:
+
+- `config.yml` — Bukkit 用の設定
+- `velocity-config.yml` — Velocity 用の設定
+
+必要に応じてこれらをサーバーのプラグイン設定フォルダにコピーして編集してください。
+
+## 使い方（デプロイ）
+
+1. 対応するサーバープラットフォーム（Bukkit/Velocity）へ JAR を配置します。
+2. サーバーを再起動またはリロードしてプラグインを読み込ませます。
+3. 設定ファイルを編集して通知メッセージやホールド挙動を調整します。
+
+## 開発者向けノート
+
+- コアのエントリポイントや各アダプタの実装は `src/main/java/net/azisaba/gracestopannouncer/` 以下を確認してください。
+- 単体テストはこのリポジトリに含まれていないようです。必要なら JUnit 等で追加してください。
+
+## ライセンス
+
+プロジェクトにライセンスファイルが含まれていない場合は、利用/配布ポリシーをリポジトリ管理者に確認してください。

README_en.md

@@ -0,0 +1,69 @@
+# README
+
+README language: English | 日本語 (README.md)
+
+---
+
+## English
+
+Overview
+
+GraceStopAnnouncer is a Java-based Minecraft server plugin that provides graceful shutdown features such as holding player connections and emitting notifications during server stop. It supports both Bukkit/Spigot and Velocity platforms.
+
+Primary uses:
+
+- Hold player connections temporarily during server shutdown to delay client disconnects
+- Receive stop notifications from external systems (e.g., load balancers or orchestration) and handle them gracefully in-plugin
+
+Key packages in this repository:
+
+- `src/main/java/net/azisaba/gracestopannouncer/bukkit/` — Bukkit adapter and plugin entry
+- `src/main/java/net/azisaba/gracestopannouncer/velocity/` — Velocity adapter and plugin entry
+- `src/main/java/net/azisaba/gracestopannouncer/core/` — Core logic shared by adapters
+- `src/main/resources/` — Default configuration files (e.g., `config.yml`, `velocity-config.yml`)
+
+## Features
+
+- Supports both Bukkit (Spigot/Paper) and Velocity
+- Pre-stop hook receiver (`PreStopHookReceiver`)
+- Connection hold handler (`HoldConnectionHandler`)
+- Message formatting utilities (`MessageFormatter`)
+
+## Requirements
+
+- Java 8 or newer
+- Maven (project uses `pom.xml`)
+
+## Build
+
+From the project root run:
+
+```bash
+mvn clean package
+```
+
+Successful build artifacts are placed in `target/` (e.g., `target/GraceStopAnnouncer.jar`).
+
+## Configuration
+
+Default configuration files live under `src/main/resources/`:
+
+- `config.yml` — for Bukkit
+- `velocity-config.yml` — for Velocity
+
+Copy and edit the appropriate file into your server's plugin config folder before starting the server.
+
+## Usage (deployment)
+
+1. Place the built JAR into the plugins/mods folder of the target server (Bukkit or Velocity).
+2. Restart or reload the server so the plugin loads.
+3. Modify configuration files to tune messages and hold behavior.
+
+## For contributors / developers
+
+- Inspect adapter implementations and core logic under `src/main/java/net/azisaba/gracestopannouncer/`.
+- There are no tests included by default; consider adding JUnit tests for key behaviors.
+
+## License
+
+If no LICENSE file is present, check with the repository owner for usage and distribution rights.