From d6a028feb7e7c3657f846889a1c0edf9f22e8dd2 Mon Sep 17 00:00:00 2001 From: Leonardo Bishop Date: Thu, 17 Jul 2025 16:33:45 +0100 Subject: Update readme --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 98883f6..d0c11a2 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,16 @@ -todo: rewrite - - # 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. +Scrapbook is a website manager, built to deploy and serve statically generated +web pages. It is designed to be as easy to use as possible, with a web interface +for management and API for programmatic site deployment. It also does not need a +database and uses the file system for organisation, to allow easy interoperability +if you wish to serve sites using another web server. -Used in conjunction with my own [static site generator](https://github.com/LMBishop/panulat) -in a GitHub workflow. +It was originally built for me to use 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 +curl -X POST -H "Authorization: Bearer (token)" -F upload=@file.zip https://publish.example.com/api/site/:site/upload ``` -- cgit v1.2.3-70-g09d2