From 131b6aab1d27d1469f7786240c895b90cf060b9a Mon Sep 17 00:00:00 2001 From: mattmcw Date: Wed, 16 Oct 2024 20:00:04 -0400 Subject: [PATCH] Add readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..01b2dd1 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# openpose API + +A quick node.js wrapper for openpose to serve it as an API from a machine with CUDA to one without. + +## POST /openpose + +Post an image to this endpoint using the field name "image" and receive the openpose data in JSON. + +Optional form fields: + +* hand *boolean* (default: false) - include hands in data +* face *boolean* (default: false) - include face in data