diff --git a/README.md b/README.md index d9d07eb..bc51200 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ If you like this plugin, [leave it a :star: on Github!](https://github.com/NickRimmer/insomnia-plugin-oa2-mate) # About -Just a mate +Just a mate Welcome aboard the 'oAuth 2 Mate' express! 🚀 @@ -12,26 +12,30 @@ Your passport to simpler authorization is just a click away. Happy coding! 🎉 ## How to use This is just one of examples (; -1. Install the plugin from [Insomnia plugin page]([Title](https://insomnia.rest/plugins/insomnia-plugin-oa2-mate)) first you it is not installed yet +### Step 1 +Install the plugin from [Insomnia plugin page]([Title](https://insomnia.rest/plugins/insomnia-plugin-oa2-mate)) first if it is not installed yet. -2. Add any request (even without endpoint) where we can configure oAuth2 and retrieve the token as usual. Click refresh to get a new token. +### Step 2 +Add any request (even without endpoint) where we can configure oAuth2 and retrieve the token as usual. Click refresh to get a new token. -Step 1 +Step 2 -3. Open your environment settings and add default header there for authorization +### Step 3 +Open your environment settings and add default header there for authorization. You can press `ctrl+space` and select `oa2_mate` from the list. ```json { "DEFAULT_HEADERS": { - "Authorization": "Bearer {% oa2_mate %}" + "Authorization": "Bearer {% oa2_mate %}" } } ``` -Step 2 +Step 3 -4. Open some request, make sure there is no authentication configured and run it. Default headers will insert authorization one with value provided by plugin +### Step 4 +Open your request, make sure there is no authentication configured and run it. Default headers will insert authorization one with value provided by plugin -Step 2 +Step 5 # How to contribute diff --git a/npm/content/README.md b/npm/content/README.md index 4cad144..2fe7c7a 100644 --- a/npm/content/README.md +++ b/npm/content/README.md @@ -1,7 +1,7 @@ If you like this plugin, [leave it a :star: on Github!](https://github.com/NickRimmer/insomnia-plugin-oa2-mate) # About -Just a mate +Just a mate Welcome aboard the 'oAuth 2 Mate' express! 🚀 @@ -12,6 +12,32 @@ Your passport to simpler authorization is just a click away. Happy coding! 🎉 ## How to use This is just one of examples (; +### Step 1 +Install the plugin from [Insomnia plugin page]([Title](https://insomnia.rest/plugins/insomnia-plugin-oa2-mate)) first if it is not installed yet. + +### Step 2 +Add any request (even without endpoint) where we can configure oAuth2 and retrieve the token as usual. Click refresh to get a new token. + +Step 2 + +### Step 3 +Open your environment settings and add default header there for authorization. You can press `ctrl+space` and select `oa2_mate` from the list. + +```json +{ + "DEFAULT_HEADERS": { + "Authorization": "Bearer {% oa2_mate %}" + } +} +``` +Step 3 + +### Step 4 +Open your request, make sure there is no authentication configured and run it. Default headers will insert authorization one with value provided by plugin + +Step 5 +This is just one of examples (; + 1. Install the plugin from [Insomnia plugin page]([Title](https://insomnia.rest/plugins/insomnia-plugin-oa2-mate)) first you it is not installed yet 2. Add any request (even without endpoint) where we can configure oAuth2 and retrieve the token as usual. Click refresh to get a new token. diff --git a/npm/content/oa2-mate-icon-medium.jpg b/npm/content/oa2-mate-icon-medium.jpg new file mode 100644 index 0000000..1b8755a Binary files /dev/null and b/npm/content/oa2-mate-icon-medium.jpg differ diff --git a/npm/content/oa2-mate-icon-small.jpg b/npm/content/oa2-mate-icon-small.jpg new file mode 100644 index 0000000..cf25100 Binary files /dev/null and b/npm/content/oa2-mate-icon-small.jpg differ diff --git a/package.json b/package.json index 2777e75..94bcc14 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "description": "Always ready with the latest oAuth 2 token as template variable. Have a stress-free coding/testing!", "unlisted": true, "images": { - "icon": "oa2-mate-icon.jpg" + "icon": "oa2-mate-icon-small.jpg" }, "publisher": { "name": "Nick Rimmer", @@ -27,8 +27,11 @@ "url": "https://github.com/NickRimmer/insomnia-plugin-oa2-mate/issues" }, "scripts": { - "publish": "node npm/generate-package.js && copyfiles -u 2 ./npm/content/* ./dist/ && copyfiles -u 1 ./src/* ./dist/ && cd dist && npm publish", - "publish-dry": "node npm/generate-package.js && copyfiles -u 2 ./npm/content/* ./dist/ && copyfiles -u 1 ./src/* ./dist/ && cd dist && npm publish --dry-run" + "build": "node npm/generate-package.js && copyfiles -u 2 ./npm/content/* ./dist/ && copyfiles -u 1 ./src/* ./dist/", + "publish": "npm run build && cd dist && npm publish", + "publish-dry": "npm run build && cd dist && npm publish --dry-run", + "install": "copyfiles -u 1 ./dist/* %appdata%/insomnia/plugins/insomnia-plugin-oa2-mate", + "install-dev": "copyfiles -u 1 ./dist/* %appdata%/insomnia-app/plugins/insomnia-plugin-oa2-mate" }, "devDependencies": { "copyfiles": "^2.4.1",