@richardmcquiston01/gcode 0.1.0 → 0.1.1

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 +23 -0
  2. package/package.json +16 -2
package/README.md CHANGED
@@ -1,3 +1,26 @@
1
1
  # @richardmcquiston01/gcode
2
2
 
3
+ G-code generation and parsing for laser, CNC and other maker machines: convert vector paths or raster images to G-code, and parse G-code back into moves with bounds.
4
+
3
5
  Part of [maker-image-tools](https://github.com/RichardMcQuiston01/maker-image-tools).
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ npm i @richardmcquiston01/gcode
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```ts
16
+ import { computeGcodeBounds, parseGcode, pathsToGcode } from "@richardmcquiston01/gcode";
17
+
18
+ const gcode: string = pathsToGcode(paths);
19
+ const bounds = computeGcodeBounds(parseGcode(gcode));
20
+ ```
21
+
22
+ ESM only.
23
+
24
+ ## License
25
+
26
+ MIT
package/package.json CHANGED
@@ -1,8 +1,22 @@
1
1
  {
2
2
  "name": "@richardmcquiston01/gcode",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "G-code generation and parsing for laser/CNC/maker machines",
5
+ "keywords": [
6
+ "gcode",
7
+ "g-code",
8
+ "laser",
9
+ "cnc",
10
+ "engraving",
11
+ "grbl",
12
+ "maker",
13
+ "typescript"
14
+ ],
5
15
  "license": "MIT",
16
+ "homepage": "https://github.com/RichardMcQuiston01/maker-image-tools#readme",
17
+ "bugs": {
18
+ "url": "https://github.com/RichardMcQuiston01/maker-image-tools/issues"
19
+ },
6
20
  "type": "module",
7
21
  "repository": {
8
22
  "type": "git",
@@ -31,7 +45,7 @@
31
45
  "typecheck": "tsc -p tsconfig.json --noEmit"
32
46
  },
33
47
  "dependencies": {
34
- "@richardmcquiston01/core-vector": "0.1.0"
48
+ "@richardmcquiston01/core-vector": "0.1.1"
35
49
  },
36
50
  "devDependencies": {
37
51
  "jsdom": "^25.0.1",