diff --git a/README.ja.md b/README.ja.md index 2b4cf76..0606707 100644 --- a/README.ja.md +++ b/README.ja.md @@ -6,15 +6,7 @@ UIを指してコメントを書き、いつものコーディングAIへ渡す MITライセンス。アカウント、MCPサーバー、特定のAIプロバイダーは必須ではありません。操作UIはReactに依存せず、Vite開発用プラグイン、またはNext.jsなどの既存HTTP開発サーバー向けレビュー用プロキシで使えます。ホスト型サービスNeedBackから独立したパッケージです。 -## ローカルで試す - -```sh -pnpm install -pnpm build -pnpm demo -``` - -`http://127.0.0.1:4190`を開き、ツールバーから対象を選んでコメントを書きます。設定で日本語・英語と、DOM・タブ・画像なしの撮影方法を選べます。デモのコメントは`demo/.needmark/feedback`に保存されます。 +[Webサイト](https://mssh21.github.io/needmark/ja/) · [ドキュメント](docs/README.md) · [npm](https://www.npmjs.com/package/needmark) ## 自分のプロジェクトに導入する @@ -67,4 +59,4 @@ DOM撮影は共有許可なしで使えますが、再現できる描画に制 - [Getting started](docs/getting-started.md): 同じ内容の英語ガイド。 - [アーキテクチャと動作上の制約(英語)](docs/architecture.md): 実装の詳細なリファレンス。 - [Agentationとの比較とプロダクト評価](docs/agentation-comparison.ja.md) -- [ドキュメント一覧](docs/README.md) · [MITライセンス](LICENSE) +- [ドキュメント一覧](docs/README.md) · [コントリビューション(英語)](CONTRIBUTING.md) · [MITライセンス](LICENSE) diff --git a/README.md b/README.md index 94994cd..877db75 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,7 @@ Point at your UI, leave a comment, and hand it to your usual coding agent. NeedM MIT licensed. It requires no account, MCP server or specific AI provider. The runtime UI does not require React; use the Vite development plugin or a separate review proxy for an existing HTTP development server, including Next.js. NeedMark is independent of hosted NeedBack. -## Try locally - -```sh -pnpm install -pnpm build -pnpm demo -``` - -Open `http://127.0.0.1:4190`. Use the toolbar to select a target and write a comment. Settings let you choose English or Japanese and DOM, tab or image-free capture. Demo feedback stays in `demo/.needmark/feedback`. +[Website](https://mssh21.github.io/needmark/) · [Documentation](docs/README.md) · [npm](https://www.npmjs.com/package/needmark) ## Install in your project @@ -67,4 +59,4 @@ Set `language: 'en'` or `'ja'` in `needmark.config.ts`; the UI defaults to Japan - [はじめに](docs/getting-started.ja.md): the same guide in Japanese. - [Architecture and operating limits](docs/architecture.md): detailed implementation reference in English. - [Agentation comparison and product evaluation (Japanese)](docs/agentation-comparison.ja.md) -- [Documentation index](docs/README.md) · [MIT license](LICENSE) +- [Documentation index](docs/README.md) · [Contributing](CONTRIBUTING.md) · [MIT license](LICENSE) diff --git a/scripts/verify-package-managers.mjs b/scripts/verify-package-managers.mjs index 68389f7..3b23229 100644 --- a/scripts/verify-package-managers.mjs +++ b/scripts/verify-package-managers.mjs @@ -20,6 +20,9 @@ const runners = { }; // Yarn 4 quarantines recently published versions, which would block checking a release right after publishing it. process.env.YARN_NPM_MINIMAL_AGE_GATE ??= '0'; +// Yarn 4 makes installs immutable whenever it detects CI, and the copied example has no lockfile yet, so the first install would be refused as a lockfile change. +// Yarn 4はCIを検出するとインストールを変更不可にし、コピーした例にはまだロックファイルがないため、最初のインストールがロックファイルの変更として拒否される。 +process.env.YARN_ENABLE_IMMUTABLE_INSTALLS ??= 'false'; const selected = (args.only ?? Object.keys(runners).join(',')).split(','); function run(command, options = {}) { diff --git a/site/favicon.svg b/site/favicon.svg new file mode 100644 index 0000000..def4e21 --- /dev/null +++ b/site/favicon.svg @@ -0,0 +1 @@ + diff --git a/site/index.html b/site/index.html index 0a10f52..68dcc78 100644 --- a/site/index.html +++ b/site/index.html @@ -7,11 +7,11 @@ - +
- NeedMark + NeedMark