Skip to content

Commit 455e429

Browse files
committed
docs(README): update for ES Modules & @octoherd/octokit
1 parent 01723aa commit 455e429

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Options:
2727
The `script` must export a `script` function which takes three parameters:
2828

2929
```js
30-
module.exports.script = async function myScript(octokit, repository, options) {
30+
export async function script(octokit, repository, options) {
3131
// do something here
32-
};
32+
}
3333
```
3434

35-
- `octokit` is an instance of [`@octokit/core`](https://github.com/octokit/core.js) with the [`@octokit/plugin-paginate-rest` plugin](https://github.com/octokit/plugin-paginate-rest.js)
35+
- `octokit` is an instance of [`@octoherd/octokit`](https://github.com/octoherd/octokit.js)
3636
- `repository` is the response data of [`GET /repos/{owner}/{repo}`](https://developer.github.com/v3/repos/#get-a-repository)
3737
- `options` are all options passed to the CLI which are not used by `octoherd`.
3838

0 commit comments

Comments
 (0)