docs(geom-axidraw): update readme

thi-ng · Jan 11, 2023 · a3ba87c · a3ba87c
1 parent 3f0b3e2
commit a3ba87c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/assets/geom-axidraw/readme-commands.png b/assets/geom-axidraw/readme-commands.png
diff --git a/packages/geom-axidraw/README.md b/packages/geom-axidraw/README.md
@@ -28,12 +28,12 @@ This project is part of the
 
 ## About
 
-Conversion and preparation of thi.ng/geom shapes & shape groups to AxiDraw pen plotter draw commands. This is a support package for [@thi.ng/geom](https://github.com/thi-ng/umbrella/tree/develop/packages/geom).
+Conversion and preparation of thi.ng/geom shapes & shape groups to/from AxiDraw pen plotter draw commands. This is a support package for [@thi.ng/geom](https://github.com/thi-ng/umbrella/tree/develop/packages/geom).
 
 This package only deals with the (bi-directional) conversion aspects between
 geometry and plotter commands. The
 [@thi.ng/axidraw](https://github.com/thi-ng/umbrella/blob/develop/packages/axidraw)
-is responsible for the actual plotter output...
+package is responsible for the actual plotter output...
 
 ### Supported shape types
 
@@ -123,6 +123,8 @@ supplied
 function, which also takes several options to customize the resulting output.
 One of the [examples](#clipping) below is demonstrating basic usage.
 
+![Example draw command visualization based on the code example in this readme](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/geom-axidraw/readme-commands.png)
+
 ### Basic usage & examples
 
 The main function of this package is the polymorphic function

diff --git a/packages/geom-axidraw/package.json b/packages/geom-axidraw/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@thi.ng/geom-axidraw",
 	"version": "0.3.0",
-	"description": "Conversion and preparation of thi.ng/geom shapes & shape groups to AxiDraw pen plotter draw commands",
+	"description": "Conversion and preparation of thi.ng/geom shapes & shape groups to/from AxiDraw pen plotter draw commands",
 	"type": "module",
 	"module": "./index.js",
 	"typings": "./index.d.ts",

diff --git a/packages/geom-axidraw/tpl.readme.md b/packages/geom-axidraw/tpl.readme.md
@@ -9,7 +9,7 @@
 This package only deals with the (bi-directional) conversion aspects between
 geometry and plotter commands. The
 [@thi.ng/axidraw](https://github.com/thi-ng/umbrella/blob/develop/packages/axidraw)
-is responsible for the actual plotter output...
+package is responsible for the actual plotter output...
 
 ### Supported shape types
 
@@ -99,6 +99,8 @@ supplied
 function, which also takes several options to customize the resulting output.
 One of the [examples](#clipping) below is demonstrating basic usage.
 
+![Example draw command visualization based on the code example in this readme](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/geom-axidraw/readme-commands.png)
+
 ### Basic usage & examples
 
 The main function of this package is the polymorphic function