openapi-client-axios - npm Package Compare versions

Comparing version 6.1.1 to 6.1.2

package.json

 {
   "name": "openapi-client-axios",
   "description": "JavaScript client library for consuming OpenAPI-enabled APIs with axios. Types included.",
-  "version": "6.1.1",
+  "version": "6.1.2",
   "author": "Viljami Kuosmanen <[e-mail]>",
@@ -76,3 +76,3 @@ "funding": "https://github.com/sponsors/anttiviljami",
   },
-  "gitHead": "db94cdf714ffcc6010abaf3c5bc5097097321c67"
+  "gitHead": "079c0c545241c7f4a7bf2c2f05e88585385a7c0c"
 }

README.md

@@ -7,4 +7,2 @@ <h1 align="center"><img alt="openapi-client-axios" src="https://github.com/anttiviljami/openapi-client-axios/raw/master/header.png?raw=true" style="max-width:50rem"></h1>
 [![bundle size](https://img.shields.io/bundlephobia/minzip/openapi-client-axios?label=gzip%20bundle)](https://bundlephobia.com/package/openapi-client-axios)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/anttiviljami/openapi-client-axios.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/anttiviljami/openapi-client-axios/alerts/)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/anttiviljami/openapi-client-axios.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/anttiviljami/openapi-client-axios/context:javascript)
 [![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/anttiviljami/openapi-client-axios/blob/master/LICENSE)
@@ -214,4 +212,38 @@ [![Buy me a coffee](https://img.shields.io/badge/donate-buy%20me%20a%20coffee-orange)](https://buymeacoff.ee/anttiviljami)
 
+## Browser Usage
+
+The `openapi-client-axios` library works both in Node.js and browsers.
+
+However, you may need to add NodeJS polyfills in your build configuration:
+
+```js
+// webpack.config.js
+const NodePolyfillPlugin = require('node-polyfill-webpack-plugin');
+
+module.exports = {
+	plugins: [new NodePolyfillPlugin()]
+};
+```
+
+```js
+// rollup.config.js
+import nodePolyfills from 'rollup-plugin-node-polyfills';
+
+export default {
+  plugins: [nodePolyfills()]
+}
+```
+
+```js
+// vite.config.js
+import { defineConfig } from 'vite'
+import { nodePolyfills } from 'vite-plugin-node-polyfills'
+
+export default defineConfig({
+  plugins: [nodePolyfills()],
+})
+```
+
 ## Contributing
 
 OpenAPI Client Axios is Free and Open Source Software. Issues and pull requests are more than welcome!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

70840

increased by0.34%

Number of lines in readme file

248

increased by14.81%

No dependency changes