Skip to content

Commit

Permalink
Merge pull request #9 from cyanolupus/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
cyanolupus authored Dec 21, 2023
2 parents 511394a + 052c851 commit 2cd1be7
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# owari.shop

## Usage
## Usage

```bash
# Put assets (fonts)
Expand All @@ -14,4 +14,33 @@ wrangler publish
wrangler dev
```

## Configuration

Edit `wrangler.toml` to configure your project.
https://developers.cloudflare.com/workers/cli-wrangler/configuration

### Workers Variables

- `WORKERS_RS_VERSION` - The version of the `workers-rs` crate to use. Defaults to `0.0.16`.
- `WILDCARDSUBDOMAIN_DOMAIN` - The domain to use for the wildcard subdomain. Defaults to `owari.shop`.
- `WILDCARDSUBDOMAIN_FONT` - The path to favicon's font file in bucket. Defaults to `Koruri-Extrabold.ttf`.
- `WILDCARDSUBDOMAIN_TOP_HALF_TEXT` - The text to display in the top half of favicon. Defaults to `おわ`.
- `WILDCARDSUBDOMAIN_BOTTOM_HALF_TEXT` - The text to display in the bottom half of favicon. Defaults to `りや`.
- `WILDCARDSUBDOMAIN_ICO_HEIGHT`, `WILDCARDSUBDOMAIN_ICO_WIDTH` `WILDCARDSUBDOMAIN_PNG_HEIGHT` `WILDCARDSUBDOMAIN_PNG_WIDTH` - The height and width of favicon. Defaults to `256`.
- `WILDCARDSUBDOMAIN_BACKGROUND_COLOR` - The background color of favicon. Defaults to `#c0c0c0ff`.
- `WILDCARDSUBDOMAIN_FONT_COLOR` - The text color of favicon. Defaults to `#000000ff`.

```toml
vars = { WORKERS_RS_VERSION = "0.0.16", WILDCARDSUBDOMAIN_DOMAIN = "owari.shop" }
```

### Workers Routes

```toml
routes = [
"owari.shop/*",
"*.owari.shop/*",
]
```

Read the latest `worker` crate documentation here: https://docs.rs/worker

0 comments on commit 2cd1be7

Please sign in to comment.