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