Initial commit

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a72c0dc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# scrapbook
+A web service which accepts zipped websites and deploys them somewhere (i.e.
+unzips them and shoves them into another directory).
+
+Might expand to serving said files as well, but for now it is intended to
+drop files into directories served by other web servers, like nginx.
+
+Used in conjunction with my own [static site generator](https://github.com/LMBishop/panulat)
+in a GitHub workflow.
+
+## Example
+
+```
+curl -X POST -u username:password -F content=@file.zip https://publish.example.com/:site/upload
+```