ts-graphviz 1.0.0-2 → 1.0.0-3

package/README.ja.md

@@ -13,6 +13,8 @@
 
 TypeScriptの ための [Graphviz](https://graphviz.gitlab.io/) ライブラリ
 
+> [GitHub](https://github.com/ts-graphviz/ts-graphviz) | [npm](https://www.npmjs.com/package/ts-graphviz)([yarn](https://github.com/ts-graphviz/ts-graphviz)) | [document](https://ts-graphviz.github.io/ts-graphviz/)
+
 ## 主な機能 ✨
 
 TypeScript に完全に統合された Graphviz DOT言語のモデルとASTを提供します。
@@ -26,17 +28,23 @@ TypeScript に完全に統合された Graphviz DOT言語のモデルとASTを
 
 ## インストール方法 💽
 
-[npm](https://www.npmjs.com/) からインストールできます。
+このパッケージは、パッケージマネージャを使用してインストールすることができます。
 
 ```bash
-# yarn
-$ yarn add ts-graphviz
-# or npm
+# npm
 $ npm install -S ts-graphviz
+# or yarn
+$ yarn add ts-graphviz
+# or pnpm
+$ pnpm add ts-graphviz
 ```
 
 ## 使い方 📑
 
+この項では、パッケージの概要について説明します。
+
+より詳細なAPIの仕様は、 TypeScript の型定義のコメントやそれを元に自動生成された [ドキュメント](https://ts-graphviz.github.io/ts-graphviz/) を参照してください。
+
 ### `ts-graphviz` モジュール 🚩
 
 DOT 言語をJavaScript/TypeScriptで扱うためのインターフェースである Model を提供します。

package/README.md

@@ -13,6 +13,8 @@
 
 [Graphviz](https://graphviz.gitlab.io/) library for TypeScript.
 
+> [GitHub](https://github.com/ts-graphviz/ts-graphviz) | [npm](https://www.npmjs.com/package/ts-graphviz)([yarn](https://github.com/ts-graphviz/ts-graphviz)) | [document](https://ts-graphviz.github.io/ts-graphviz/)
+
 ## Key Features ✨
 
 `ts-graphviz` package provides models and ASTs for the Graphviz DOT language fully integrated with TypeScript.
@@ -26,17 +28,23 @@
 
 ## Installation 💽
 
-This package can then be installed using [npm](https://www.npmjs.com/):
+This package can then be installed using a package manager.
 
 ```bash
-# yarn
-$ yarn add ts-graphviz
-# or npm
+# npm
 $ npm install -S ts-graphviz
+# or yarn
+$ yarn add ts-graphviz
+# or pnpm
+$ pnpm add ts-graphviz
 ```
 
 ## Usage 📑
 
+This section provides an overview of the package.
+
+For more detailed API specifications, please refer to the comments in the TypeScript type definitions and the [document](https://ts-graphviz.github.io/ts-graphviz/) automatically generated based on them.
+
 ### `ts-graphviz` Module 🚩
 
 This module provides **Model**, an interface for working with the DOT language in JavaScript/TypeScript.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-graphviz",
-  "version": "1.0.0-2",
+  "version": "1.0.0-3",
   "author": "kamiazya <yuki@kamiazya.tech>",
   "description": "Graphviz library for TypeScript.",
   "homepage": "https://ts-graphviz.github.io/ts-graphviz/",

package/media/state-machine.dot

@@ -1,10 +0,0 @@
-digraph state_machine {
-  node [ shape = circle ]
-
-  { rank = same; Model; AST; DOT; }
-
-  Model -> DOT [ label = "toDot" ]
-  AST   -> DOT [ label = "stringify" ]
-  DOT   -> AST [ label = "parse" ]
-  Model -> AST [ label = "fromModel" ]
-}

package/media/ts-graphviz.dot

@@ -1,20 +0,0 @@
-digraph state_machine {
-  rankdir = LR;
-  node [ shape = circle ]
-
-  // { rank = same; builder_fn; Model; DOT; }
-
-  builder_fn [
-    shape = record,
-    label = "{{Builder Functions | strict.digraph(...)\lstrict.graph(...)\ldigraph(...)\lgraph(...)\l}}"
-  ]
-
-  oop [
-    shape = record,
-    label = "{{Object Oriented Programing | new Digraph(...)\lnew Graph(...)\l...\l}}"
-  ]
-
-  {builder_fn, oop} -> Model;
-
-  Model -> DOT [ label = "toDot" ]
-}