Skip to content

Commit 27270bc

Browse files
committed
docs: streamline readme workflow
1 parent dee57c5 commit 27270bc

1 file changed

Lines changed: 4 additions & 23 deletions

File tree

README.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,20 @@
22

33
[![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)
44

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.
66

77
## Documentation
88

99
The website is the source of truth for setup and operations:
1010

1111
* [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/)
1813
* [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/)
2115

2216
## Local Workflow
2317

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.
3819

3920
## Contributions
4021

0 commit comments

Comments
 (0)