graphics-debug 0.0.5 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -131,6 +131,36 @@ const graphicsObjects = getGraphicsObjectsFromLogString(logString)
131
131
  // Array<GraphicsObject>
132
132
  ```
133
133
 
134
+ ### Example Graphics JSON
135
+
136
+ An example graphics JSON file is provided in the repository to help you get started quickly.
137
+
138
+ You can find the example file at [`site/examples/exampleGraphics.json`](site/examples/exampleGraphics.json). This file contains a sample graphics object that you can use to test the functionality of the `graphics-debug` module.
139
+
140
+ Here is the content of the `exampleGraphics.json` file:
141
+
142
+ ```JSON
143
+ {
144
+ "title": "Example Usage",
145
+ "rects": [
146
+ {
147
+ "center": { "x": 0, "y": 0 },
148
+ "width": 100,
149
+ "height": 100,
150
+ "fill": "green"
151
+ }
152
+ ],
153
+ "points": [
154
+ {
155
+ "x": 50,
156
+ "y": 50,
157
+ "color": "red",
158
+ "label": "Test Output!"
159
+ }
160
+ ]
161
+ }
134
162
  ```
135
163
 
136
- ```
164
+ You can load this example into the application to visualize the graphics objects and understand how the `graphics-debug` module works.
165
+
166
+
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "graphics-debug",
3
3
  "main": "dist/lib/index.js",
4
4
  "type": "module",
5
- "version": "0.0.5",
5
+ "version": "0.0.6",
6
6
  "files": [
7
7
  "dist"
8
8
  ],