palt-typesetting 0.1.3 → 0.1.4

package/README.md

@@ -1,7 +1,6 @@
 # Typesetting Library for Propotional Spacing
 
-Palt Typesetting は、読みやすく美しいテキスト表示を実現するための JavaScript ライブラリです。  
-和欧混合、およびメトリクス詰め（`font-feature-settings: 'palt'`）の組版において、最大限の力を発揮します。
+Palt Typesetting は、読みやすく美しいテキスト表示を実現するための JavaScript ライブラリです。和欧混合、およびメトリクス詰め（`font-feature-settings: 'palt'`）の組版において、最大限の力を発揮します。
 
 四分アキの自動挿入、カーニングルールの適用、英語のような語単位での改行など、高度な組版機能を提供します。
 
@@ -23,7 +22,7 @@ typesetter.renderToSelector('.my-class')
 ### Use from CDN
 
 ```html
-<script src="https://unpkg.com/palt-typesetting@0.1.3/bundle/palt-typesetting.min.js"></script>
+<script src="https://unpkg.com/palt-typesetting@0.1.4/bundle/palt-typesetting.min.js"></script>
 ```
 
 ```html
@@ -51,7 +50,7 @@ typesetter.renderToSelector('.my-class')
 }
 ```
 
-## Methods
+## Typesetter Class
 
 ### Usage
 
@@ -73,7 +72,13 @@ console.log(typesetter.render(srcHtml))
 // <span class="typeset" /* 中略 */>「日本語」<span class="typeset-thin-space" style="font-size: 50%;" /* 中略 */> </span><wbr>と<span class="typeset-thin-space" style="font-size: 50%;" /* 中略 */> </span><wbr><span class="typeset-latin">English</span></span>
 ```
 
-### Typesetter Class Methods
+### Constructor
+
+| コンストラクタ             | 説明                                                                                                  | 引数                            |
+| -------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------- |
+| `new Typesetter(options?)` | Typesetter インスタンスを作成します。<br>オプションを指定することでカスタムの組版設定を適用できます。 | `options`: オプション（任意）。 |
+
+### Methods
 
 | メソッド名                   | 説明                                                                  | 引数                                                         | 返り値                                   |
 | ---------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------- |
@@ -119,6 +124,7 @@ const options = {
 }
 
 const typeset = new Typesetter(options)
+typesetter.renderToSelector('.my-class')
 ```
 
 ### Typesetting Options
@@ -133,6 +139,23 @@ const typeset = new Typesetter(options)
 | `thinSpaceWidth`         | 四分アキスペースの幅を設定します。<br>`addThinSpaces` が `true` の場合にのみ有効です。                                                    | `string`                                                 | `'50%' `     |
 | `kerningRules`           | 特定の文字間のカーニングルールを設定します。                                                                                              | `{between: [string, string], value: string \| number}[]` | `[]`         |
 
-## Important Notice
+## Notes
+
+### 環境要件
+
+Palt Typesetting ライブラリは、語単位の改行機能のコアとして `Intl.Segmenter` による分割処理を使用しています。そのため、以下の環境要件があります：
+
+- Node.js: 16.0.0 以上。
+- ブラウザ: Intl.Segmenter をサポートしているブラウザ。
+
+`Intl.Segmenter` は、テキストを言語固有のセグメントに分割する機能を提供しますが、一部のブラウザでは利用できません（クライアントサイドで実行する場合）。Palt Typesetting は、`Intl.Segmenter` がサポートされていない環境では組版処理をスキップし、元のテキストをそのまま返します。
+
+`Intl.Segmenter` の対応状況については、[MDN Web Docs](https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter) で確認できます。
+
+### 注意事項
+
+Palt Typesetting ライブラリは HTML 入力をサポートしていますが、入力された HTML をサニタイズする機能は**含まれていません**。 入力を信頼できない場合は、適切なサニタイザライブラリと共に使用することを強く推奨します。
+
+## Author
 
-Palt Typesetting ライブラリは HTML の入力をサポートしていますが、入力された HTML をサニタイズ**しません。** 入力を信頼できない場合は、適切なサニタイザライブラリと共に使用することを推奨します。
+飯塚 大和 (Yamato Iizuka)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "palt-typesetting",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "A Japanese typesetting library, primarily focused on proportional spacing (font-feature-settings: 'palt').",
   "main": "./dist/index.js",
   "files": [