Skip to content

Commit a559d50

Browse files
authored
docs: update README.md (#48)
1 parent 770e130 commit a559d50

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Website for [https://plugins.dprint.dev](https://plugins.dprint.dev).
44

5-
## Redirect to Any GitHub Repo (For Plugin Authors)
5+
## URLs to Any GitHub Repo (For Plugin Authors)
66

77
This service provides a convenient URL for a plugin stored in any GitHub repo.
88

@@ -11,7 +11,7 @@ To use it, create a GitHub release in your repo with:
1111
1. Plugin named `plugin.wasm` (use `plugin.json` for process plugins)
1212
1. JSON schema named `schema.json` (if exists)
1313

14-
Then your redirect urls will look like:
14+
Then your URLs will look like:
1515

1616
```
1717
https://plugins.dprint.dev/<username>/<repo_name>-<tag_name>.wasm
@@ -24,7 +24,9 @@ Restrictions and recommendations:
2424
1. Tag names must not contain a dash (`-`).
2525
1. It is recommended to use the format `x.x.x` for your tag names to be consistent with other plugins (ex. no leading `v` like `v1.0.0`).
2626

27-
If your repo name is in the format `dprint-plugin-<something>` then you can omit `dprint-plugin-` in the `<repo_name>` for the redirect (ex. `https://plugins.dprint.dev/<user>/dprint-plugin-typescript-0.0.0.wasm` may be shortened to `https://plugins.dprint.dev/<user>/typescript-0.0.0.wasm`).
27+
If your repo name is in the format `dprint-plugin-<something>` then you can omit `dprint-plugin-` in the `<repo_name>` for the URL (ex. `https://plugins.dprint.dev/<user>/dprint-plugin-typescript-0.0.0.wasm` may be shortened to `https://plugins.dprint.dev/<user>/typescript-0.0.0.wasm`).
28+
29+
Note that once a URL is cached it is cached forever by the service.
2830

2931
## Release Assets
3032

@@ -40,7 +42,7 @@ For example:
4042
https://plugins.dprint.dev/dprint/dprint-plugin-prettier/0.67.0/asset/dprint-plugin-prettier-aarch64-apple-darwin.zip
4143
```
4244

43-
This is useful for process plugins that distribute platform-specific binaries. Assets are cached in R2 for persistence.
45+
This is useful for process plugins that distribute platform-specific binaries (unfortunately [this bug](https://github.com/dprint/dprint/pull/1114) prevents using relative URLs for some time). Assets are cached in R2 for persistence.
4446

4547
Note: To get approved, open a PR to this repository including your username and plugin repo.
4648

0 commit comments

Comments
 (0)