Skip to content

docs: update README.md #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsherret merged 1 commit into from
Mar 26, 2026
+6 −4
Merged

docs: update README.md #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

## Redirect to Any GitHub Repo (For Plugin Authors)
## URLs to Any GitHub Repo (For Plugin Authors)

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

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

Then your redirect urls will look like:
Then your URLs will look like:

```
https://plugins.dprint.dev/<username>/<repo_name>-<tag_name>.wasm
Expand All @@ -24,7 +24,9 @@ Restrictions and recommendations:
1. Tag names must not contain a dash (`-`).
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`).

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`).
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`).

Note that once a URL is cached it is cached forever by the service.

## Release Assets

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

This is useful for process plugins that distribute platform-specific binaries. Assets are cached in R2 for persistence.
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.

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

Expand Down
Loading