|
2 | 2 |
|
3 | 3 | [](LICENSE) [](.github/CODE_OF_CONDUCT.md) [](#contributors) |
4 | 4 |
|
5 | | -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. |
| 5 | +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 that Cloudflare deploys. |
6 | 6 |
|
7 | 7 | ## Documentation |
8 | 8 |
|
9 | 9 | The website is the source of truth for setup and operations: |
10 | 10 |
|
11 | 11 | * [Getting started](https://www.VanityURLs.link/en/docs/getting-started/) |
12 | | -* [Cloudflare deployment](https://www.VanityURLs.link/en/docs/cloudflare/) |
13 | | -* [Repository layout](https://www.VanityURLs.link/en/docs/repository-layout/) |
14 | | -* [Customization model](https://www.VanityURLs.link/en/docs/customize-overview/) |
15 | | -* [Link format](https://www.VanityURLs.link/en/docs/link-format/) |
16 | | -* [Schedules](https://www.VanityURLs.link/en/docs/schedules/) |
17 | | -* [Destination policies](https://www.VanityURLs.link/en/docs/blocklist/) |
| 12 | +* [Customize your instance](https://www.VanityURLs.link/en/docs/customize-overview/) |
18 | 13 | * [Local CLI](https://www.VanityURLs.link/en/docs/cli/) |
19 | | -* [Runtime registry](https://www.VanityURLs.link/en/docs/runtime-registry/) |
20 | | -* [Validation and CI](https://www.VanityURLs.link/en/docs/validation-ci/) |
| 14 | +* [Full documentation](https://www.VanityURLs.link/en/docs/) |
21 | 15 |
|
22 | 16 | ## Local Workflow |
23 | 17 |
|
24 | | -Common commands: |
25 | | - |
26 | | -```sh |
27 | | -npm install |
28 | | -npm run setup |
29 | | -npm run local-install |
30 | | -npm run check |
31 | | -npm run build |
32 | | -./scripts/lnk --help |
33 | | -``` |
34 | | - |
35 | | -Run `npm run setup` first to configure the instance, then `npm run local-install` to install workstation helpers. Run `npm run local-publish` after local edits when you want checks, commit selection, and push handled in one step. |
36 | | - |
37 | | -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. |
| 18 | +Run `npm run setup` first to configure the instance, then `npm run local-install` to install workstation helpers. Run `npm run local-publish` after local edits when you want checks, commit selection, and push handled in one step. Run `./scripts/lnk --help` for the local link-management quick reference. |
38 | 19 |
|
39 | 20 | ## Contributions |
40 | 21 |
|
|
0 commit comments