diff --git a/README.md b/README.md index 30cfc67..641faac 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,15 @@ CircleCI is a useful service for previewing document builds. However, by default their artifact server behaves differently from a standard static pages server, in that it does not render `foo/bar` from -`foo/bar/index.html`. +`foo/bar/index.html`. They store files on S3, and certain URLs may +also redirect, causing CORS issues. This CloudFlare Worker proxy fixes that, by fetching missing `foo/bar` pages from `foo/bar/index.html`. It also tries `foo/bar.html`, just in case (e.g., this is useful for static page builds in older versions of the `mystmd` document engine, which did not yet provide `index.html` -pages). +pages). It follows redirects, and returns the final result. + ## Usage @@ -22,8 +24,6 @@ Action](https://github.com/scientific-python/circleci-artifacts-redirector-actio to automatically provide that link in the status of your GH preview build. -If you replace `output.circle-artifacts.com` with -`circle.scientific-python.dev`, the requests will go through this -proxy (see `worker.js`), and will render pages correctly, as described above. - -**TODO:** Update `circleci-artifact-redirector-action` to accept a different base domain. +Using its `domain` option, replace `output.circle-artifacts.com` with +`circle.scientific-python.dev` to send requests through this proxy, +which will render routes correctly, as described above.