add webpack usage

2020-08-20 01:28:01 -06:00 · 2020-08-20 01:28:01 -06:00 · b2fc0ebf35
parent af7ee5426f
commit b2fc0ebf35
1 changed files with 69 additions and 6 deletions
--- a/README.md
+++ b/README.md
@ -20,6 +20,8 @@ and [Rasha.js (RSA)](https://git.coolaj86.com/coolaj86/rasha.js/).
    -   [ ] Auth0
 -   [ ] CLI
    -   See [keypairs-cli](https://npmjs.com/packages/keypairs-cli/)
+-   [x] Node
+-   [x] Browsers (Webpack >=5)

 <!--

@ -86,6 +88,67 @@ return Keypairs.signJwt({
 By default ECDSA keys will be used since they've had native support in node
 _much_ longer than RSA has, and they're smaller, and faster to generate.

+## Webpack 5+ (for Browsers)
+
+This package includes native browser versions of all special functions.
+
+Since Webpack 5 now fully supports vanilla JavaScript and exclusive browser builds out-of-the-box,
+it's pretty easy to create a minimal config to use Keypairs in your browser projects:
+
+`webpack.config.js`:
+
+```js
+'use strict';
+
+var path = require('path');
+
+module.exports = {
+	entry: './main.js',
+	mode: 'development',
+	devServer: {
+		contentBase: path.join(__dirname, 'dist'),
+		port: 3001
+	},
+	output: {
+		publicPath: 'http://localhost:3001/'
+	},
+	module: {
+		rules: [{}]
+	},
+	plugins: []
+};
+```
+
+`main.js`:
+
+```js
+'use strict';
+
+var Keypairs = require('./keypairs.js');
+
+Keypairs.generate().then(function (pair) {
+	console.log(pair.private);
+	console.log(pair.public);
+});
+```
+
+`index.html`:
+
+```html
+<!DOCTYPE html>
+<html>
+	<body>
+		<script src="./dist/main.js"></script>
+	</body>
+</html>
+```
+
+```bash
+npm install --save-dev webpack@5
+npx webpack
+ls dist/
+```
+
 ## API Overview

 -   generate (JWK)