Skip to content

Commit

Permalink
docs: base plugin documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eGavr committed Jun 29, 2022
1 parent 3c177cf commit 8ca787d
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# hermione-oauth

Plugin for convenient setting of authorization header with OAuth token
Some Remote WebDriver Servers requires OAuth authorization for each request. This plugin is useful for setting of authorization header with OAuth token.

## Install

```bash
npm install hermione-oauth --save-dev
```

## Usage

```js
// .hermione.conf.js
module.exports = {
// ...
plugins: {
"hermione-oauth": {
enabled: true, // plugin is enabled by default
token: "<token>", // option also accepts absolute filepath with a token
help: "https://...", // information on where to get a token
},
},
};
```

Each plugin option can be redefined by
- environment variable which starts with prefix `hermione_oauth_`, for example, `hermione_oauth_token=123-456-789`
- CLI option which starts with prefix `--oauth-`, for example, `--oauth-token=123-456-789`

0 comments on commit 8ca787d

Please sign in to comment.