Skip to content

Provide userscript metadata that works #2

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

Open
chocolateboy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Provide userscript metadata that works #2

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: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,18 @@ Usage Example
-------------

Tell your user script to use MonkeyConfig by placing a `@require` directive in
the metadata section:
the metadata section alongside the `@grant` permissions it requires:

```javascript
// ==UserScript==
// @name AwesomeScript
// @require https://raw.github.com/odyniec/MonkeyConfig/master/monkeyconfig.js
// @description My awesome userscript
// @require https://cdn.rawgit.com/odyniec/MonkeyConfig/51456c3a36b9b6febe61d1351de16466c90695d2/monkeyconfig.js
// @grant GM_getValue
// @grant GM_setValue
// @grant GM_addStyle
// @grant GM_registerMenuCommand
// ==/UserScript==
```

Then, call `MonkeyConfig()` to construct your configuration object:
Expand Down