From 905e93c56b23a3b22fbbd84b3e503884e713656b Mon Sep 17 00:00:00 2001
From: shimwell <mail@jshimwell.com>
Date: Fri, 4 Apr 2025 17:48:28 +0200
Subject: [PATCH 1/3] removed loc and color

---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 494be15..cead888 100644
--- a/README.md
+++ b/README.md
@@ -51,8 +51,8 @@ insert.faces("<X").tag("~in_contact")
 insert.faces(">X").tag("outer-right")
 
 assy = cq.Assembly()
-assy.add(shell, name="shell", loc=cq.Location(cq.Vector(0, 0, 0)), color=cq.Color("red"))
-assy.add(insert, name="insert", loc=cq.Location(cq.Vector(0, 0, 0)), color=cq.Color("blue"))
+assy.add(shell, name="shell")
+assy.add(insert, name="insert")
 
 assy.saveToGmsh(mesh_path="tagged_mesh.msh")
 ```
@@ -77,8 +77,8 @@ insert.faces("<X").tag("~in_contact")
 insert.faces(">X").tag("outer-right")
 
 assy = cq.Assembly()
-assy.add(shell, name="shell", loc=cq.Location(cq.Vector(0, 0, 0)), color=cq.Color("red"))
-assy.add(insert, name="insert", loc=cq.Location(cq.Vector(0, 0, 0)), color=cq.Color("blue"))
+assy.add(shell, name="shell")
+assy.add(insert, name="insert")
 
 # Get a Gmsh object back with all the tagged faces as physical groups
 gmsh = assy.getTaggedGmsh()
@@ -89,7 +89,7 @@ gmsh.model.mesh.generate(3)
 gmsh.write(mesh_path)
 gmsh.finalize()
 ```
-
+, loc=cq.Location(cq.Vector(0, 0, 0)), color=cq.Color("blue"
 ## Tests
 
 These tests are also run in Github Actions, and the meshes which are generated can be viewed as artifacts on the successful `tests` Actions there.

From de8f63455d2067d945510030fe7100550a64be7d Mon Sep 17 00:00:00 2001
From: shimwell <mail@jshimwell.com>
Date: Fri, 4 Apr 2025 17:51:25 +0200
Subject: [PATCH 2/3] corrected import pkg name

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cead888..c990bd3 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,7 @@ If you want more control over the mesh generation and export, you can use the `g
 
 ```python
 import cadquery as cq
-import cadquery_assembly_mesh_plugin.plugin
+import assembly_mesh_plugin.plugin
 import gmsh
 
 shell = cq.Workplane("XY").box(50, 50, 50)

From 9efe906d020f8e13a11806510f825fdb5181e833 Mon Sep 17 00:00:00 2001
From: shimwell <mail@jshimwell.com>
Date: Fri, 4 Apr 2025 17:55:54 +0200
Subject: [PATCH 3/3] removed unknown mesh_path keyword

---
 README.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index c990bd3..743e5cf 100644
--- a/README.md
+++ b/README.md
@@ -81,15 +81,15 @@ assy.add(shell, name="shell")
 assy.add(insert, name="insert")
 
 # Get a Gmsh object back with all the tagged faces as physical groups
-gmsh = assy.getTaggedGmsh()
+gmsh_object = assy.getTaggedGmsh()
 
 # Generate the mesh and write it to the file
-gmsh.model.mesh.field.setAsBackgroundMesh(2)
-gmsh.model.mesh.generate(3)
-gmsh.write(mesh_path)
-gmsh.finalize()
+gmsh_object.model.mesh.field.setAsBackgroundMesh(2)
+gmsh_object.model.mesh.generate(3)
+gmsh_object.write("tagged_mesh.msh")
+gmsh_object.finalize()
 ```
-, loc=cq.Location(cq.Vector(0, 0, 0)), color=cq.Color("blue"
+
 ## Tests
 
 These tests are also run in Github Actions, and the meshes which are generated can be viewed as artifacts on the successful `tests` Actions there.