specv 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 daiki-beppu
+
+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,79 +1,85 @@
-# mdv
+# specv
 
-カレントディレクトリの Markdown ファイルを GitHub 風にブラウザプレビューする CLI ツール。
+A CLI tool that previews Markdown files in the current directory with GitHub-style rendering in your browser.
 
 ## Features
 
-- GitHub Flavored Markdown (GFM) レンダリング
-- シンタックスハイライト付きコードブロック + コピーボタン
-- Preview / Source 切替
-- ファイルツリー (サイドバー) + 検索
-- VSCode 風 Quick Open (`Cmd+P`) with fzf ファジー検索
-- サイドバートグル (`Cmd+B`)
-- ダーク / ライトモード切替 (OS 追従 + 手動切替)
-- GitHub ダークテーマ準拠の配色
-- ポート自動検出 (衝突時に次のポートを試行)
+- GitHub Flavored Markdown (GFM) rendering
+- Syntax-highlighted code blocks with copy button
+- Preview / Source toggle
+- File tree (sidebar) with search
+- VSCode-style Quick Open (`Cmd+P`) with fzf fuzzy search
+- Sidebar toggle (`Cmd+B`)
+- Dark / Light mode (follows OS preference + manual toggle)
+- GitHub dark theme color scheme
+- Automatic port detection (tries next port on conflict)
 
 ## Install
 
 ```bash
-# ローカルビルド
-git clone https://github.com/daiki-beppu/mdv.git
-cd mdv
-pnpm install
-pnpm build
-npm link
+npm install -g specv
 ```
 
 ## Usage
 
 ```bash
-# カレントディレクトリの .md をプレビュー
-mdv
+# Preview .md files in the current directory
+specv
 
-# ポート指定
-mdv -p 3000
+# Specify a port
+specv -p 3000
 ```
 
-ブラウザが自動で開き、Markdown ファイルを GitHub 風にレンダリング表示します。
+A browser window opens automatically, rendering your Markdown files with GitHub-style formatting.
 
 ## Keyboard Shortcuts
 
-| Shortcut           | Action                    |
-| ------------------ | ------------------------- |
-| `Cmd+P` / `Ctrl+P` | Quick Open (ファイル検索) |
-| `Cmd+B` / `Ctrl+B` | サイドバー開閉            |
+| Shortcut           | Action              |
+| ------------------ | ------------------- |
+| `Cmd+P` / `Ctrl+P` | Quick Open (search) |
+| `Cmd+B` / `Ctrl+B` | Toggle sidebar      |
 
 ## Architecture
 
 ```
-Express Server (API) ─── React SPA (Vite build)
-  /api/files             FileTree + Preview + Source
-  /api/file?path=...     react-markdown + prism-react-renderer
+Hono Server (API) ─── React SPA (Vite build)
+  /api/files            FileTree + Preview + Source
+  /api/file?path=...    react-markdown + prism-react-renderer
 ```
 
-- **Server:** Express 5 + commander (CLI)
+- **Server:** Hono + @hono/node-server + commander (CLI)
 - **Client:** React 19 + Vite + Tailwind CSS v4
-- **Markdown:** react-markdown + remark-gfm + github-markdown-css
+- **Markdown:** react-markdown + remark-gfm
 - **Search:** fzf (fuzzy finder) + TanStack Hotkeys
-- **Security:** パストラバーサル検証、.md ファイルのみアクセス許可
+- **Security:** Path traversal protection, restricted to .md files only
 
 ## Development
 
 ```bash
-# クライアント開発サーバー (HMR)
+# Client dev server (HMR)
 pnpm dev:client
 
-# サーバー開発
+# Server development
 pnpm dev:server
 
-# テスト
+# Run tests
 pnpm test
 
-# ビルド
+# Build
 pnpm build
 ```
 
+## CI/CD
+
+Automated via GitHub Actions:
+
+- **CI** — Runs lint / knip / typecheck / test / build on PRs and main pushes
+- **Publish** — Publishes to npm on GitHub Release creation (Trusted Publishing)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
 ## License
 
-MIT
+[MIT](LICENSE)