From 59323f514151aba97229aba1d9220a47390ee060 Mon Sep 17 00:00:00 2001 From: Alexander Cerutti Date: Mon, 24 Apr 2023 16:56:16 +0200 Subject: [PATCH] Improved Readme to include ESM import --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e40888e..2e28cbc 100644 --- a/README.md +++ b/README.md @@ -122,15 +122,23 @@ This is a standard procedure: you would have to do it also without using this li ## Usage Examples -#### Folder Model +Importing: ```typescript -/** - * Use `const { PKPass } = require("passkit-generator");` - * for usage in CommonJS (Node.js) - */ +/** CommonJS **/ +const { PKPass } = require("passkit-generator"); + +/** Typescript **/ import { PKPass } from "passkit-generator"; +/** ESM **/ +import passkit from "passkit-generator"; +const PKPass = passkit.PKPass; +``` + +### Folder Model + +```typescript try { /** Each, but last, can be either a string or a Buffer. See API Documentation for more */ const { wwdr, signerCert, signerKey, signerKeyPassphrase } = getCertificatesContentsSomehow(); @@ -169,15 +177,9 @@ try { } ``` -#### Buffer Model +### Buffer Model ```typescript -/** - * Use `const { PKPass } = require("passkit-generator");` - * for usage in CommonJS (Node.js) - */ -import { PKPass } from "passkit-generator"; - try { /** Each, but last, can be either a string or a Buffer. See API Documentation for more */ const { wwdr, signerCert, signerKey, signerKeyPassphrase } = getCertificatesContentsSomehow();