Skip to content

Commit d8fea3d

Browse files
committed
docs: streamline readme
1 parent 46524fd commit d8fea3d

1 file changed

Lines changed: 4 additions & 48 deletions

File tree

README.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,23 @@
11
![logo](.github/banner.png)
22

33
[![License](https://img.shields.io/github/license/vanityURLs/code?style=flat-square&labelColor=111827&color=0F766E)](LICENSE)
4+
[![Release](https://img.shields.io/github/v/release/vanityURLs/code?style=flat-square&labelColor=111827&color=0F766E)](https://github.com/vanityURLs/code/releases/latest)
45
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-0F766E?style=flat-square&labelColor=111827)](.github/CODE_OF_CONDUCT.md)
56
[![All Contributors](https://img.shields.io/badge/all_contributors-4-0F766E?style=flat-square&labelColor=111827)](#contributors)
67

78
vanityURLs is a Cloudflare Workers redirector for running a branded short-link domain as code. Links, schedules,
89
destination policies, localized instance pages, and operator configuration live in Git; the build produces the Worker
910
assets that Cloudflare deploys.
1011

11-
## Documentation
12-
13-
The website is the source of truth for setup and operations:
14-
15-
- [Getting started](https://www.VanityURLs.link/en/docs/getting-started/)
16-
- [Customize your instance](https://www.VanityURLs.link/en/docs/customize-overview/)
17-
- [Local CLI](https://www.VanityURLs.link/en/docs/cli/)
18-
- [Full documentation](https://www.VanityURLs.link/en/docs/)
12+
The [documentation](https://vanityurls.link/en/docs/setup/) on the website is the source of truth for setup and
13+
operations.
1914

2015
## Quickstart
2116

2217
Before starting, you need a registered short domain, GitHub and Cloudflare accounts, Git, Node.js 20 or newer, npm, and
2318
a text editor. The short domain must use Cloudflare as its authoritative DNS provider before the Worker can serve it.
2419

25-
Clone the vanityURLs code, detach the clone from the upstream project, then install dependencies:
26-
27-
```bash
28-
git clone https://github.com/vanityurls/code.git redirector
29-
cd redirector
30-
npm run detach
31-
npm install
32-
```
33-
34-
Run the installer, install local helpers, then validate the plain instance:
35-
36-
```bash
37-
npm run setup
38-
npm run local-install
39-
npm run check
40-
```
41-
42-
Review `wrangler.toml` and set the Worker name plus the route or custom domain for your short domain. Keep
43-
instance-specific files in `custom/`; do not edit `defaults/` unless you are contributing upstream changes to vanityURLs
44-
itself.
45-
46-
Initialize Git, push the repository to GitHub, and connect it to Cloudflare Workers & Pages. You can also deploy
47-
manually:
48-
49-
```bash
50-
npx wrangler deploy --config wrangler.toml
51-
```
52-
53-
After the first redirect works, use the documentation to customize branding, legal pages, analytics, protected
54-
dashboards, and local workstation helpers.
55-
56-
## Local Workflow
57-
58-
Run `npm run setup` first to configure the instance, then `npm run local-install` to install workstation helpers. Run
59-
`npm run local-publish` after local edits when you want checks, commit selection, and push handled in one step. Run
60-
`./scripts/v8s-lnk --help` for the local link-management quick reference. `./scripts/lnk` remains a compatibility alias.
61-
62-
Command prefixes are grouped: `npm run test`, `npm run validate`, and `npm run smoke` run their whole group, while
63-
focused variants such as `test:worker`, `validate:targets`, and `smoke:analytics` run one layer. Run `npm run help` for
64-
the full command list and rationale.
20+
Follow the [documentation](https://vanityurls.link/en/docs/quickstart) to spin your vanityURLs' instance.
6521

6622
## Contributions
6723

0 commit comments

Comments
 (0)