diff options
| author | Leonardo Bishop <me@leonardobishop.net> | 2025-07-17 16:33:45 +0100 |
|---|---|---|
| committer | Leonardo Bishop <me@leonardobishop.net> | 2025-07-17 16:33:45 +0100 |
| commit | d6a028feb7e7c3657f846889a1c0edf9f22e8dd2 (patch) | |
| tree | 998a97e3493cd57ee8e8f0ac648960f218b6b702 /README.md | |
| parent | 36a2a1943db63d6cb65d7ceb2fdd096c34f1683d (diff) | |
Update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 8 insertions, 10 deletions
@@ -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 ``` |
