diff --git a/README.md b/README.md index 89c36cd..e1e1a9f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # WebArc +`webarc` is a local website archive based on [monolith](https://github.com/Y2Z/monolith). -- Website Archive -- LLM AI Integration (VectorDB)? -- Regex Search +## Configuration +You can configure the application using environment variables: +- `$ROUTE_INTERNAL` : Rewrite links to point back to the archive itself +- `$DOWNLOAD_ON_DEMAND` : Download missing routes with monolith on demand + +## Usage +Archived pages can be viewed at `/s//`. +For example, `/s/en.wikipedia.org/wiki/Website` will serve `en.wikipedia.org` at `/wiki/Website`. + +To select an archive from a certain time, add `?time=YYYY-MM-DD` parameter to the URL.