npm - @gurezo/web-serial-rxjs - Versions diffs - 0.1.16 → 0.1.18 - Mend

@gurezo/web-serial-rxjs 0.1.16 → 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.ja.md CHANGED Viewed

@@ -1,7 +1,7 @@
 # web-serial-rxjs
 <p align="center">
-  <img src="https://raw.githubusercontent.com/gurezo/web-serial-rxjs/main/packages/web-serial-rxjs/web-serial-rxjs-icon.png" alt="web-serial-rxjs プロジェクトアイコン" width="512" />
+  <img src="https://raw.githubusercontent.com/gurezo/web-serial-rxjs/main/assets/icon/web-serial-rxjs-icon.png" alt="web-serial-rxjs プロジェクトアイコン" width="512" />
 </p>
 Web Serial API を RxJS ベースのリアクティブなラッパーで提供する TypeScript ライブラリです。Web アプリケーションでシリアルポート通信を簡単に実現できます。
@@ -9,10 +9,13 @@ Web Serial API を RxJS ベースのリアクティブなラッパーで提供
 ## 目次
 - [機能](#機能)
+- [対応フレームワーク](#対応フレームワーク)
 - [ブラウザサポート](#ブラウザサポート)
 - [インストール](#インストール)
 - [ドキュメント](#ドキュメント)
-- [フレームワーク別の例](#フレームワーク別の例)
+- [サンプル](#サンプル)
+- [プロジェクトアイコンについて](#プロジェクトアイコンについて)
+- [開発とリリース戦略](#開発とリリース戦略)
 - [貢献](#貢献)
 - [ライセンス](#ライセンス)
 - [リンク](#リンク)
@@ -25,6 +28,15 @@ Web Serial API を RxJS ベースのリアクティブなラッパーで提供
 - **エラーハンドリング**: カスタムエラークラスとエラーコードによる包括的なエラーハンドリング
 - **フレームワーク非依存**: 任意の JavaScript/TypeScript フレームワークまたはバニラ JavaScript で使用可能
+## 対応フレームワーク
+このライブラリはフレームワーク非依存で、以下の環境で利用できます。
+- Angular
+- React
+- Svelte
+- Vanilla JavaScript / TypeScript
 ## ブラウザサポート
 Web Serial API は現在、Chromium ベースのブラウザでのみサポートされています：
@@ -59,23 +71,47 @@ pnpm add rxjs
 ## ドキュメント
-- **[クイックスタート](docs/QUICK_START.ja.md)** - 基本的な例と使用方法のパターンで始める
+- **[クイックスタート](docs/QUICK_START.ja.md)** - 基本的な例と使用方法で始める
 - **[API リファレンス](docs/API_REFERENCE.ja.md)** - 詳細な説明を含む完全な API ドキュメント
 - **[高度な使用方法](docs/ADVANCED_USAGE.ja.md)** - 高度なパターン、ストリーム処理、エラー回復
-## フレームワーク別の例
+## サンプル
-このリポジトリには、さまざまなフレームワークで web-serial-rxjs を使用する方法を示すサンプルアプリケーションが含まれています：
+以下の環境向けのサンプルを用意しています。
+- **[Angular](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-angular)** - Service を使用した Angular の例
+- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - カスタムフック（`useSerialClient`）を使用した React の例
+- **[Svelte](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-svelte)** - Svelte Store を使用した Svelte の例
 - **[Vanilla JavaScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-js)** - バニラ JavaScript での基本的な使用方法
 - **[Vanilla TypeScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-ts)** - RxJS を使用した TypeScript の例
-- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - カスタムフック（`useSerialClient`）を使用した React の例
 - **[Vue](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vue)** - Composition API を使用した Vue 3 の例
-- **[Svelte](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-svelte)** - Svelte Store を使用した Svelte の例
-- **[Angular](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-angular)** - Service を使用した Angular の例
 各例には、セットアップと使用方法の説明を含む README が含まれています。
+## プロジェクトアイコンについて
+このプロジェクトのアイコンには、[RxJS](https://rxjs.dev/) のロゴから着想を得たデザインに、
+Web Serial を表すシリアルコネクタのモチーフを組み合わせたものを使用しています。
+このアイコンは、本ライブラリが Web Serial API を RxJS ベースで扱うための
+ライブラリであることを示す目的でのみ使用しています。
+本プロジェクトは **[ReactiveX](http://reactivex.io/) / [RxJS](https://rxjs.dev/) 公式とは関係のない独立したオープンソースプロジェクト** であり、
+公式な提携・承認・スポンサー関係はありません。
+## 開発とリリース戦略
+このプロジェクトは**trunk-based開発**アプローチに従います：
+- **`main`ブランチ**: 常にリリース可能な状態
+- **短命ブランチ**: `feature/*`, `fix/*`, `docs/*` はプルリクエスト用
+- **リリース**: ブランチではなくGitタグ（例: `v1.0.0`）で管理
+- **バージョン保守**: 複数のメジャーバージョンを保守する必要がある場合のみ `release/v*` ブランチを追加
+詳細な貢献ガイドラインについては、[CONTRIBUTING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.ja.md) を参照してください。
+詳細なリリース手順については、[RELEASING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.ja.md) を参照してください。
 ## 貢献
 貢献を歓迎します！詳細については、[貢献ガイド](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.ja.md)を参照してください：
@@ -84,9 +120,12 @@ pnpm add rxjs
 - コードスタイルガイドライン
 - コミットメッセージの規約
 - プルリクエストのプロセス
+- リリースプロセス
 英語版の貢献ガイドは [CONTRIBUTING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.md) を参照してください。
+リリース手順については、[RELEASING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.ja.md)（または英語版は [RELEASING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.md)）を参照してください。
 ## ライセンス
 このプロジェクトは MIT ライセンスの下で公開されています。詳細は [LICENSE](https://github.com/gurezo/web-serial-rxjs/blob/main/LICENSE) ファイルを参照してください。

package/README.md CHANGED Viewed

@@ -1,7 +1,7 @@
 # web-serial-rxjs
 <p align="center">
-  <img src="https://raw.githubusercontent.com/gurezo/web-serial-rxjs/main/packages/web-serial-rxjs/web-serial-rxjs-icon.png" alt="web-serial-rxjs project icon" width="512" />
+  <img src="https://raw.githubusercontent.com/gurezo/web-serial-rxjs/main/assets/icon/web-serial-rxjs-icon.png" alt="web-serial-rxjs project icon" width="512" />
 </p>
 A TypeScript library that provides a reactive RxJS-based wrapper for the Web Serial API, enabling easy serial port communication in web applications.
@@ -9,10 +9,14 @@ A TypeScript library that provides a reactive RxJS-based wrapper for the Web Ser
 ## Table of Contents
 - [Features](#features)
+- [Framework Support](#framework-support)
 - [Browser Support](#browser-support)
 - [Installation](#installation)
 - [Documentation](#documentation)
-- [Framework Examples](#framework-examples)
+- [Examples](#examples)
+- [Project Icon](#project-icon)
+- [AI Assistant (MCP)](#ai-assistant-mcp)
+- [Development and Release Strategy](#development-and-release-strategy)
 - [Contributing](#contributing)
 - [License](#license)
 - [Links](#links)
@@ -25,6 +29,15 @@ A TypeScript library that provides a reactive RxJS-based wrapper for the Web Ser
 - **Error handling**: Comprehensive error handling with custom error classes and error codes
 - **Framework agnostic**: Works with any JavaScript/TypeScript framework or vanilla JavaScript
+## Framework Support
+This library is framework-agnostic and can be used with:
+- Angular
+- React
+- Svelte
+- Vanilla JavaScript / TypeScript
 ## Browser Support
 The Web Serial API is currently only supported in Chromium-based browsers:
@@ -63,19 +76,60 @@ pnpm add rxjs
 - **[API Reference](docs/API_REFERENCE.md)** - Complete API documentation with detailed descriptions
 - **[Advanced Usage](docs/ADVANCED_USAGE.md)** - Advanced patterns, stream processing, and error recovery
-## Framework Examples
+## Examples
-This repository includes example applications demonstrating how to use web-serial-rxjs with different frameworks:
+Examples are available for the following environments:
+- **[Angular](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-angular)** - Angular example using a Service
+- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - React example with custom hook (`useSerialClient`)
+- **[Svelte](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-svelte)** - Svelte example using Svelte Store
 - **[Vanilla JavaScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-js)** - Basic usage with vanilla JavaScript
 - **[Vanilla TypeScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-ts)** - TypeScript example with RxJS
-- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - React example with custom hook (`useSerialClient`)
 - **[Vue](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vue)** - Vue 3 example using Composition API
-- **[Svelte](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-svelte)** - Svelte example using Svelte Store
-- **[Angular](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-angular)** - Angular example using a Service
 Each example includes a README with setup and usage instructions.
+## Project Icon
+The project icon includes a modified design inspired by the [RxJS](https://rxjs.dev/) logo,
+combined with a serial connector motif to represent Web Serial communication.
+The icon is used only to indicate that this library provides
+RxJS-based abstractions for the Web Serial API.
+This project is an independent open source project and is **not affiliated with,
+endorsed by, or sponsored by the [ReactiveX](http://reactivex.io/) or [RxJS](https://rxjs.dev/) project**.
+## AI Assistant (MCP)
+This project includes [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server configuration for AI-assisted development. The following MCP servers are available:
+| Server          | Purpose                                                                                |
+| --------------- | -------------------------------------------------------------------------------------- |
+| **nx-mcp**      | Nx workspace analysis, project graph, CI monitoring, and documentation                 |
+| **angular-cli** | Angular CLI tools for example-angular (code generation, documentation, best practices) |
+| **svelte**      | Svelte/SvelteKit documentation and code analysis for example-svelte                    |
+**Configuration files:**
+- `.mcp.json` - Standard MCP configuration (Cursor, VS Code, Claude, etc.)
+- `.cursor/mcp.json` - Cursor-specific configuration
+To use MCP servers in Cursor, the configuration is automatically loaded from `.cursor/mcp.json`. For VS Code, add the MCP extension and configure it to use `.mcp.json`, or add the server definitions to your MCP settings.
+## Development and Release Strategy
+This project follows a **trunk-based development** approach:
+- **`main` branch**: Always in a release-ready state
+- **Short-lived branches**: `feature/*`, `fix/*`, `docs/*` for pull requests
+- **Releases**: Managed via Git tags (e.g., `v1.0.0`), not branches
+- **Version maintenance**: `release/v*` branches are added only when needed for maintaining multiple major versions
+For detailed contribution guidelines, see [CONTRIBUTING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.md).
+For detailed release instructions, see [RELEASING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.md).
 ## Contributing
 We welcome contributions! Please see our [Contributing Guide](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.md) for details on:
@@ -84,9 +138,12 @@ We welcome contributions! Please see our [Contributing Guide](https://github.com
 - Code style guidelines
 - Commit message conventions
 - Pull request process
+- Release process
 For Japanese contributors, please see [CONTRIBUTING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.ja.md).
+For release instructions, see [RELEASING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.md) (or [RELEASING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.ja.md) for Japanese).
 ## License
 This project is licensed under the MIT License - see the [LICENSE](https://github.com/gurezo/web-serial-rxjs/blob/main/LICENSE) file for details.

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@gurezo/web-serial-rxjs",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "RxJS-based utilities for the Web Serial API, usable from Angular, React, Svelte, and Vanilla JavaScript/TypeScript.",
   "author": "Akihiko Kigure <akihiko.kigure@gmail.com>",
   "license": "MIT",