@riebeckite/plugin-changelog 0.0.38 → 0.0.40

package/README.md

@@ -2,10 +2,10 @@
 
 <!-- Generated from docs/docs/plugins/changelog.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-Build-time change history derived from local Git history. For every published
-note the plugin adds a "change history" section with commit dates, subjects,
-and authors, and it can build a site-wide changelog dataset from the notes'
-commits. No client-side JavaScript is required.
+Build-time change history derived from local Git history. The plugin reads
+commit dates, subjects, and authors for notes, renders change history sections,
+and can build a site-wide changelog dataset from the notes' commits. The Site
+decides where to render each section. No client-side JavaScript is required.
 
 [日本語](./README_ja.md)
 
@@ -22,6 +22,12 @@ changelog dataset is built and available for the app to render itself. The
 plugin contributes no markup to the manifest entry; the Site renders the
 changelog sections it wants. No client script is registered.
 
+## Installation
+
+```sh
+npm install @riebeckite/plugin-changelog
+```
+
 ## Usage
 
 ```ts

package/README_ja.md

@@ -2,7 +2,7 @@
 
 <!-- Generated from docs/docs/plugins/changelog.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-ローカル Git の履歴からビルド時に変更履歴を生成するプラグインです。公開ノートごとにコミット日・件名・作成者を並べた「変更履歴」セクションを追加し、サイト全体の変更履歴データセットも組み立てられます。クライアント JavaScript は不要です。
+ローカル Git の履歴からビルド時に変更履歴を生成するプラグインです。ノートのコミット日・件名・作成者を読み取り、「変更履歴」セクションを描画して、サイト全体の変更履歴データセットも組み立てられます。各セクションをどこに表示するかはサイト側が決めます。クライアント JavaScript は不要です。
 
 [English](./README.md)
 
@@ -12,6 +12,12 @@
 
 結果はプラグインの組み込み HTML レンダラーを通じて公開されます。公開エントリはそれぞれ変更履歴セクションを受け取り、サイト側のレイアウトが描画するかどうかを決めます。`siteWide` を有効にすると、サイト全体の変更履歴データセットがビルドされ、アプリが自身で描画できます。プラグインはマニフェストエントリにマークアップを挿入しません。描画する変更履歴セクションはサイト側が選びます。クライアントスクリプトは登録しません。
 
+## インストール
+
+```sh
+npm install @riebeckite/plugin-changelog
+```
+
 ## 使い方
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-changelog",
-  "version": "0.0.38",
+  "version": "0.0.40",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,8 +21,8 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.38",
-    "@riebeckite/git-history": "0.0.38",
+    "@riebeckite/core": "0.0.40",
+    "@riebeckite/git-history": "0.0.40",
     "hono": "^4.12.25"
   },
   "devDependencies": {