narou 1.1.0 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2015 deflis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,34 +1,74 @@
-# node-narou
+# 📚 node-narou
 
-[なろうデベロッパー](https://dev.syosetu.com/)の API を fluent interface で利用できるラッパーライブラリです。
-ブラウザでの JSONP の利用も可能です。
+[![npm version](https://badge.fury.io/js/narou.svg)](https://badge.fury.io/js/narou)
+[![Node.js CI](https://github.com/deflis/node-narou/actions/workflows/nodejs-test.yml/badge.svg)](https://github.com/deflis/node-narou/actions/workflows/nodejs-test.yml)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/deflis/node-narou)
 
-以下の API をラップしています。
+[なろうデベロッパー](https://dev.syosetu.com/)の API を fluent interface で利用できる TypeScript ライブラリです。  
+A TypeScript wrapper library for Narou Developer APIs with fluent interface.
 
-- [なろう小説 API](https://dev.syosetu.com/man/api/)
-- [なろう小説ランキング API](https://dev.syosetu.com/man/rankapi/)
-- [なろう殿堂入り API](https://dev.syosetu.com/man/rankinapi/)
-- [なろう R18 小説 API](https://dev.syosetu.com/xman/api/)
+## ✨ 特徴
 
-## Installation
+- 🔗 **メソッドチェーン対応**: 直感的な fluent interface で API を操作
+- 🌐 **マルチ環境対応**: Node.js とブラウザの両方で動作
+- 📝 **TypeScript 完全対応**: 型安全性と IntelliSense サポート
+- 🔀 **デュアル実装**: fetch (Node.js) と JSONP (ブラウザ) を自動選択
+- 📚 **全 API カバー**: なろうデベロッパーの全 API に対応
 
-以下のコマンドでインストールできます。
+## 🚀 対応 API
 
-```
+| API | 説明 | 関数 |
+|-----|------|------|
+| [なろう小説 API](https://dev.syosetu.com/man/api/) | 小説の検索・絞り込み | `search()` |
+| [なろう小説ランキング API](https://dev.syosetu.com/man/rankapi/) | ランキング取得 | `ranking()` |
+| [なろう殿堂入り API](https://dev.syosetu.com/man/rankinapi/) | ランキング履歴取得 | `rankingHistory()` |
+| [なろう R18 小説 API](https://dev.syosetu.com/xman/api/) | 18禁小説検索 | `searchR18()` |
+| [なろうユーザ検索 API](https://dev.syosetu.com/man/userapi/) | ユーザー検索 | `searchUser()` |
+
+## 📦 インストール
+
+```bash
+# 推奨: pnpm
+pnpm add narou
+
+# または
 npm install narou
+yarn add narou
+```
+
+## 🚀 クイックスタート
+
+### Node.js での使用
+
+```typescript
+import { search, ranking } from "narou";
+import { Genre, Order, RankingType } from "narou";
+
+// 異世界恋愛小説を検索
+const result = await search("異世界")
+  .genre(Genre.RenaiIsekai)
+  .order(Order.FavoriteNovelCount)
+  .limit(10)
+  .execute();
+
+console.log(`${result.allcount}件の小説が見つかりました`);
 ```
 
-## Usage - API
+### ブラウザでの使用
 
-https://deflis.github.io/node-narou/ を参照してください。
+```typescript
+// ブラウザでは専用のインポートを使用（JSONP対応）
+import { search } from "narou/browser";
 
-ブラウザで利用したい場合 `narou/browser` をimportしてください。こちらを利用することで自動的にfetch(nodejs)への依存がなくなり、JSONPを利用するようになります。
+const result = await search("魔法").execute();
+```
 
-すでにサポート終了していますがfetchをサポートしないNode.jsバージョンで利用する場合は 、 `NarouNovelFetch` にfetchのNode.js実装を渡してください。
-なお、その場合の動作は確認していないので動かなければIssueを立ててください。
+## 📖 詳細な API ドキュメント
 
+- **🔗 [完全な API ドキュメント](https://deflis.github.io/node-narou/)** - TypeDoc で生成された詳細なドキュメント
+- **🤖 [LLM 向けドキュメント](https://deflis.github.io/node-narou/llms.txt)** - AI/LLM が理解しやすい形式のドキュメント（TypeDoc JSON から自動生成）
 
-## Example
+## 📝 使用例
 
 ```typescript
 import { search, ranking, rankingHistory, searchR18 } from "narou";
@@ -108,32 +148,35 @@ for (const novel of searchR18Result.values) {
 }
 ```
 
-## Development
-
-```
-
-# watch
+## 🛠️ 開発
 
-npm run watch
+このプロジェクトでは pnpm を使用しています。
 
-# build
+```bash
+# 依存関係のインストール
+pnpm install
 
-npm run build
+# ビルド
+pnpm run build
 
-# test
+# テスト実行
+pnpm run test
 
-npm run test
+# 型チェック
+pnpm run check
 
+# ドキュメント生成（TypeDoc + llms.txt）
+pnpm run docs
 ```
 
-## Contributing
+## 🤝 コントリビューション
 
-1. Fork it!
-2. Create your feature branch: `git checkout -b my-new-feature`
-3. Commit your changes: `git commit -am 'Add some feature'`
-4. Push to the branch: `git push origin my-new-feature`
-5. Submit a pull request :D
+1. このリポジトリをフォーク
+2. フィーチャーブランチを作成: `git checkout -b my-new-feature`
+3. 変更をコミット: `git commit -am 'Add some feature'`
+4. ブランチにプッシュ: `git push origin my-new-feature`
+5. プルリクエストを作成
 
-## License
+## 📄 ライセンス
 
-MIT
+MIT License - 詳細は [LICENSE](LICENSE) ファイルを参照してください。