From 7f99e16de27a637b44280d01e1048b831dc2d98f Mon Sep 17 00:00:00 2001 From: David Sherret Date: Wed, 25 Mar 2026 22:59:28 -0400 Subject: [PATCH] chore: update readme --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 65cc319..1256792 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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//-.wasm @@ -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-` then you can omit `dprint-plugin-` in the `` for the redirect (ex. `https://plugins.dprint.dev//dprint-plugin-typescript-0.0.0.wasm` may be shortened to `https://plugins.dprint.dev//typescript-0.0.0.wasm`). +If your repo name is in the format `dprint-plugin-` then you can omit `dprint-plugin-` in the `` for the URL (ex. `https://plugins.dprint.dev//dprint-plugin-typescript-0.0.0.wasm` may be shortened to `https://plugins.dprint.dev//typescript-0.0.0.wasm`). + +Note that once a URL is cached it is cached forever by the service. ## Release Assets @@ -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.