Added hot swap and file import capabilities for modification of switch plates.

1 files changed, 11 insertions, 0 deletions

diff --git a/README.md b/README.md
index fec9d90..18d7151 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,17 @@ As part of the effort to create a new engine I converted the code to cadquery/Op
 
 ![STEP File in FreeCAD](./resources/FreeCAD_STEP_screen.png)
 
+## Added Feature
+Added a new switch for hot swap and a way to include any additional geometry in the key plate by use of an imported file.  For hot swap just change the line to `hot_swap = True`.  To import an arbitrary geometry set the `plate_file = None` and `plate_offset = 0.0`.  The file must be .step for OpenCascade / cadquery and .stl for openSCAD / solid python.  The zero reference should be the key center (XY), and the top of the plate (Z).  Plate offset is a Z-axis translation for minor adjustments without modifying the geometry file.  If you don't want the "nubs" you have to modify the plate function.  It will propagate to all key plate usage.  
+
+**DISCLAIMER:  I have not built the hot swap version and cannot speak to the geometry.  I found it running around in various places and don't know the origin.**  
+
+If you know the origin I would like to credit the originator.  If you test it I'd love to know how well it works or if you come up with a better geometry I'm happy to add it.  
+
+Message me on Reddit u/j_oshreve if you are really stuck.  I don't have much time to help, but can answer the occasional question.  Also feel free to put in a pull request if you come up with something crafty and want to give others access to it.
+
+![Hot Swap in OpenSCAD](./resources/Openscad_hot_swap.png)
+
 ## Status / Future
 FWIW, the cadquery version is essentially a double translation and is now a bit of a mess.  I wanted to share with the community as the first version of dactyl-manuform that exports as a STEP file, allowing easier editing.  I am happy to maintain the code, but I am unlikely to spend much more time cleaning it up as I am working on an entirely new object-oriented generator in Python/cadquery.  This was my proof of concept for eliminating OpenSCAD from the workflow and I thought it worth giving back to the community.