docs: simplify readme

Author: bhdicaire

.all-contributorsrc

@@ -1,6 +1,6 @@
 {
   "projectName": "vanityURLs",
-  "projectOwner": "bhdicaire",
+  "projectOwner": "vanityURLs",
   "repoType": "github",
   "repoHost": "https://github.com",
   "files": [

README.md

@@ -1,95 +1,39 @@
 ![logo](.github/banner.png)
 
-[![GitHub license](https://img.shields.io/github/license/bhdicaire/vanityURLs)](https://github.com/vanityURLs/code/blob/main/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-40F766E.svg)](code_of_conduct.md) [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?color=0F766E&style=flat-square)](#contributors)
+[![License](https://img.shields.io/github/license/vanityURLs/code?style=flat-square&labelColor=111827&color=0F766E)](LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-0F766E?style=flat-square&labelColor=111827)](.github/CODE_OF_CONDUCT.md) [![All Contributors](https://img.shields.io/badge/all_contributors-4-0F766E?style=flat-square&labelColor=111827)](#contributors)
 
-vanityURLs is a _simple_ solution to deploy a budget-friendly Url Shortener. It runs at scale in your Cloudflare subscription with continuous integration.
+vanityURLs is a Cloudflare Workers redirector for running a branded short-link domain as code. Links, schedules, destination policies, localized instance pages, and operator configuration live in Git; the build produces the Worker assets Cloudflare deploys.
 
-> If you don't own an a Cloudflare subscription already, you can create your free account today so you can experience everything without spending a dime.
+## Documentation
 
-Features:
- * Fully branded internet domain using Cloudflare's [DNS](https://www.cloudflare.com/en-ca/application-services/products/dns/) & [Pages](https://pages.cloudflare.com/) so your links are compact and pretty
- * URL redirection (301, 302, 303, 307 and 308)
- * Advanced redirection with splats (e.g., /news/*  → /blog/:splat )
- * Continuous integration managed by Cloudflare Page Engine
- * Configurable destination policies with `blocked_keywords` in `v8s-policies.json`
- * Exact-match destination previews through `/expand/` and the `v8s --print <slug>` CLI helper
- * Link expiration dates with the `expires_at` field in `v8s-links.txt`
+The website is the source of truth for setup and operations:
 
-My objective is to work at the command line and automate it. So feel free to fork, and customize.
+* [Getting started](https://www.VanityURLs.link/en/docs/getting-started/)
+* [Cloudflare deployment](https://www.VanityURLs.link/en/docs/cloudflare/)
+* [Repository layout](https://www.VanityURLs.link/en/docs/repository-layout/)
+* [Customization model](https://www.VanityURLs.link/en/docs/customize-overview/)
+* [Link format](https://www.VanityURLs.link/en/docs/link-format/)
+* [Schedules](https://www.VanityURLs.link/en/docs/schedules/)
+* [Destination policies](https://www.VanityURLs.link/en/docs/blocklist/)
+* [Local CLI](https://www.VanityURLs.link/en/docs/cli/)
+* [Runtime registry](https://www.VanityURLs.link/en/docs/runtime-registry/)
+* [Validation and CI](https://www.VanityURLs.link/en/docs/validation-ci/)
 
-## What problem does it solve and why is it useful?
+## Local Workflow
 
-You’ve been there too, a fully branded short URLs is useful but your low volume does not justify a commercial solution. Furthermore, links generated by a free solution will eventually expire and they're not privacy friendly.
+Common commands:
 
-This kind of solution is known as TinyURL, tiny url, shorten that long URL, URL Shortening Service,  goo.gl, bit.ly, short.io, etc.
+```sh
+npm install
+npm run setup
+npm run check
+npm run build
+./scripts/lnk --help
+```
 
-### It's bullet proof
+Run `npm run local-install` to install workstation helpers and create local configuration. Run `npm run local-publish` after local edits when you want checks, commit selection, and push handled in one step.
 
-As long as you secure your Github and Cloudflare accounts with robust authentication, there is not much that can go wrong with such simple solution. It use the products as designed, there is no hack involved.
-
-## Setup
-
-1. Register a _tiny_ internet domain name with your [preferred vendor](https://www.cloudflare.com/en-ca/products/registrar/)
-2. If you don't own an a [Cloudflare subscription](https://dash.cloudflare.com/) already, you need to create a free account
-3. Add the _tiny_ internet domain name to [Cloudflare DNS](https://dash.cloudflare.com/)
-4. [Follow the instructions](https://vanityurls.link/en/docs/getting-started/) to fork the GitHub repository and customize your setup
-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
-
-## Implemented request references
-
-The 2.x runtime includes a few requested capabilities that are easy to
-miss because they are implemented through configuration or helper scripts:
-
-* Short URL policies are handled through `blocked_keywords` in
-  `defaults/v8s-policies.json` or an instance-specific
-  `custom/v8s-policies.json`.
-* Looking up a destination from a short name is available in two places:
-  `/expand/` previews exact-match short links in the deployed Worker, and
-  `v8s --print <slug>` prints a destination from the generated local
-  registry after `npm run build`. Run `npm run local-install` once to
-  install the Bash/Zsh helper and opt in to local registry syncing.
-* Expiration dates are stored with the `expires_at` field in
-  `v8s-links.txt`; `./scripts/lnk --expires-at DATE ...` writes that
-  value, and the Worker treats expired links as expired at runtime.
-
-## Developer CLI reference
-
-Use `./scripts/lnk --help` as the local quick reference for link,
-schedule, and block policy edits. The detailed product documentation lives
-at <https://www.VanityURLs.link/en/docs>.
-
-Run `npm run local-install` to create or update
-`custom/v8s-local-config.json`, install the shell helper, install the
-`lnk` CLI, and write the local repository path used by workstation helpers.
-Run `npm run local-publish` after manual local edits; it runs
-`npm run check`, then commits and pushes the configured local paths with the
-commit message from `v8s-local-config.json`. It uses a more specific
-configured message when only `custom/v8s-links.txt`,
-`custom/v8s-policies.json`, or `custom/v8s-site-config.json` changed.
-
-The CLI intentionally documents only the user-facing environment flags:
-
-* `DRY_RUN=true` prints the planned change without writing, committing, or
-  pushing.
-* `V8S_REPO=PATH` points copied local helpers at the local repository path.
-* `V8S_LINKS_OWNER=OWNER` changes the default owner field for new links.
-* `V8S_LINKS_FILE=FILE` overrides the links file.
-* `V8S_SCHEDULES_FILE=FILE` overrides the schedule file.
-* `V8S_POLICY_FILE=FILE` overrides the block policy file.
-
-Successful write operations run `npm run check`, then commit and push
-automatically so Cloudflare can deploy the generated site.
-
-## Limitations
-
-As this code is deployed on Cloudflare Pages, there are some product limits to be aware of:
-
-* A maximum of 2,000 static redirects and 100 dynamic redirects, for a combined total of 2,100 redirects ([source](https://developers.cloudflare.com/pages/platform/limits/#redirects)).
-* The Free plan supports up to 500 automated builds per month ([source](https://developers.cloudflare.com/pages/platform/limits/#builds)).
-
-Most of these limits wouldn't be reached in general use, but it's good to note for larger-scale deployments.
-
-Platform-wise, the `lnk` scripts require `bash` and so are not natively compatible with Windows at this time.
+See the [CLI documentation](https://www.VanityURLs.link/en/docs/cli/) and [custom override documentation](https://www.VanityURLs.link/en/docs/custom-overrides/) for the details.
 
 ## Contributions
 
@@ -101,10 +45,10 @@ Platform-wise, the `lnk` scripts require `bash` and so are not natively compatib
 <table>
   <tbody>
     <tr>
-      <td align="center" valign="top" width="16.66%"><a href="https://github.com/bhdicaire"><img src="https://avatars.githubusercontent.com/u/1316765?v=4?s=100" width="100px;" alt="Benoît H. Dicaire"/><br /><sub><b>Benoît H. Dicaire</b></sub></a><br /><a href="https://github.com/bhdicaire/vanityURLs/commits?author=bhdicaire" title="Code">💻</a> <a href="https://github.com/bhdicaire/vanityURLs/commits?author=bhdicaire" title="Documentation">📖</a> <a href="#security-bhdicaire" title="Security">🛡️</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="https://github.com/bhdicaire"><img src="https://avatars.githubusercontent.com/u/1316765?v=4?s=100" width="100px;" alt="Benoît H. Dicaire"/><br /><sub><b>Benoît H. Dicaire</b></sub></a><br /><a href="https://github.com/vanityURLs/code/commits?author=bhdicaire" title="Code">💻</a> <a href="https://github.com/vanityURLs/code/commits?author=bhdicaire" title="Documentation">📖</a> <a href="#security-bhdicaire" title="Security">🛡️</a></td>
       <td align="center" valign="top" width="16.66%"><a href="http://felixleger.com"><img src="https://avatars.githubusercontent.com/u/7781739?v=4?s=100" width="100px;" alt="Félix Léger"/><br /><sub><b>Félix Léger</b></sub></a><br /><a href="#ideas-felleg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#userTesting-felleg" title="User Testing">📓</a> <a href="#promotion-felleg" title="Promotion">📣</a></td>
-      <td align="center" valign="top" width="16.66%"><a href="https://xvii.au"><img src="https://avatars.githubusercontent.com/u/446329?v=4?s=100" width="100px;" alt="Jake Edwards"/><br /><sub><b>Jake Edwards</b></sub></a><br /><a href="https://github.com/bhdicaire/vanityURLs/commits?author=XVII" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="16.66%"><a href="https://github.com/slig"><img src="https://avatars.githubusercontent.com/u/37779?v=4?s=100" width="100px;" alt="Tiago Serafim"/><br /><sub><b>Tiago Serafim</b></sub></a><br /><a href="https://github.com/bhdicaire/vanityURLs/commits?author=slig" title="Code">💻</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="https://xvii.au"><img src="https://avatars.githubusercontent.com/u/446329?v=4?s=100" width="100px;" alt="Jake Edwards"/><br /><sub><b>Jake Edwards</b></sub></a><br /><a href="https://github.com/vanityURLs/code/commits?author=XVII" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="https://github.com/slig"><img src="https://avatars.githubusercontent.com/u/37779?v=4?s=100" width="100px;" alt="Tiago Serafim"/><br /><sub><b>Tiago Serafim</b></sub></a><br /><a href="https://github.com/vanityURLs/code/commits?author=slig" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>
@@ -118,4 +62,4 @@ Platform-wise, the `lnk` scripts require `bash` and so are not natively compatib
  * [dnsConfiguration](https://github.com/bhdicaire/dnsConfiguration) – Automated DNS configuration with StackOverflow's DNSControl and Git
 
 ## Licence
-**vanityURLs** is Copyright 2023 Benoît H. Dicaire and [licensed under the MIT licence](https://github.com/vanityURLs/vanityURLs/blob/main/LICENSE).
+**vanityURLs** is Copyright 2023 Benoît H. Dicaire and [licensed under the MIT licence](https://github.com/vanityURLs/code/blob/main/LICENSE).