Skip to content

Commit 079d2c9

Browse files
feildmasterclaude
andcommitted
docs: use USER/REPO for github releases in plugin.updater
The updater docs showed @USER/REPO, but the parser has no handling for a leading @ and requests repos/@USER/REPO, which GitHub answers with a 404. The form that works is USER/REPO, so document that. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 9a937a7 commit 079d2c9

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎docs/_api/plugin/updater.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ data
1515
: Where to find updates. One of:
1616
* A `string`. A link to the download. GitHub and gist links are supported.
1717
* `{ downloadURL }`. The same, as an object.
18-
* `{ updateURL }`. A link to something the version can be read from: a userscript, a `.meta.js` file, a gist, or a GitHub release (`@USER/REPO`). The download link is read from its `@downloadURL`, or from the release's `.user.js` file.
18+
* `{ updateURL }`. A link to something the version can be read from: a userscript, a `.meta.js` file, a gist, or a GitHub release (`USER/REPO`). The download link is read from its `@downloadURL`, or from the release's `.user.js` file.
1919
* Both. `downloadURL` is only needed when it cannot be found from `updateURL`.
2020

2121
Return Value
@@ -30,7 +30,7 @@ plugin.canUpdate
3030
const plugin = underscript.plugin('My great plugin', '1.2.0');
3131

3232
// GitHub release
33-
plugin.updater({ updateURL: '@USER/REPO' });
33+
plugin.updater({ updateURL: 'USER/REPO' });
3434

3535
// Or a link to the script
3636
plugin.updater('https://example.com/my-plugin.user.js');

0 commit comments

Comments
 (0)