implement POST /validate-interior

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83364a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Lulu Book Printing API Client
+
+[https://api.lulu.com/docs/](https://api.lulu.com/docs/)
+
+
+## Testing
+
+Some of the tests require a connection to the sandbox API.
+Before running the tests you must copy and paste your "client key" and "client secret" from the
+[Sandbox API Keys Page](https://developers.sandbox.lulu.com/user-profile/api-keys)
+into the files `testdata/clientkey` and `testdata/clientsecret`.
+
+For example, if your client-key and client-secret were `190f024a-fded-f508-7db8-a987b1159f40` and `dSdCXch8SCIcAksu6CXd1SzvfYUUdjPs`,
+
+```sh
+mkdir testdata
+echo 190f024a-fded-f508-7db8-a987b1159f40 >testdata/clientkey
+echo dSdCXch8SCIcAksu6CXd1SzvfYUUdjPs >testdata/clientsecret
+chmod 600 testdata/clientkey testdata/clientsecret
+```
+
+The tests make connections to Lulu's sandbox API server.
+Please be polite and don't run the tests too often to avoid spamming their server.