Skip to content

Commit 5cf8c39

Browse files
committed
docs: document shipped feature requests
1 parent f859170 commit 5cf8c39

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Features:
1111
* URL redirection (301, 302, 303, 307 and 308)
1212
* Advanced redirection with splats (e.g., /news/* → /blog/:splat )
1313
* Continuous integration managed by Cloudflare Page Engine
14+
* Configurable destination blocklists with `blocked_keywords` in `v8s-blocklist.json`
15+
* Exact-match destination previews through `/expand/` and the `v8s --print <slug>` CLI helper
16+
* Link expiration dates with the `expires_at` field in `v8s-links.txt`
1417

1518
My objective is to work at the command line and automate it. So feel free to fork, and customize.
1619

@@ -32,6 +35,22 @@ As long as you secure your Github and Cloudflare accounts with robust authentica
3235
4. [Follow the instructions](https://vanityurls.link/en/docs/getting-started/) to fork the GitHub repository and customize your setup
3336
5. Use the [`lnk` bash script](https://vanityurls.link/en/docs/guide/advanced/cli/) to shorten, personalize, and share fully branded short URLs with continuous integration on Cloudflare
3437

38+
## Implemented request references
39+
40+
The 2.x runtime includes a few requested capabilities that are easy to
41+
miss because they are implemented through configuration or helper scripts:
42+
43+
* Short URL blocklists are handled through `blocked_keywords` in
44+
`defaults/v8s-blocklist.json` or an instance-specific
45+
`custom/v8s-blocklist.json`.
46+
* Looking up a destination from a short name is available in two places:
47+
`/expand/` previews exact-match short links in the deployed Worker, and
48+
`v8s --print <slug>` prints a destination from the generated local
49+
registry after `npm run build`.
50+
* Expiration dates are stored with the `expires_at` field in
51+
`v8s-links.txt`; `./scripts/lnk --expires-at DATE ...` writes that
52+
value, and the Worker treats expired links as expired at runtime.
53+
3554
## Limitations
3655

3756
As this code is deployed on Cloudflare Pages, there are some product limits to be aware of:

0 commit comments

Comments
 (0)