summaryrefslogtreecommitdiffhomepage
path: root/packages/typescript-types/README.md
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2023-08-22 10:13:03 -0700
committerGitHub <noreply@github.com>2023-08-22 10:13:03 -0700
commitfefc95e4535e6ecf903f647124a492fba3fd11d6 (patch)
tree4c924d43d32fb12a780533302eaf5dee08875d75 /packages/typescript-types/README.md
parent443c341bc2163f07b93a3ef84a43294d10b826f8 (diff)
parent2935857c76d458c26701842e500f8d97d17499c5 (diff)
Merge pull request #425 from MasterKale/feat/server-esm-take-2-dnt
feat/server-esm-take-2-dnt
Diffstat (limited to 'packages/typescript-types/README.md')
-rw-r--r--packages/typescript-types/README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/packages/typescript-types/README.md b/packages/typescript-types/README.md
index 5190592..2220d02 100644
--- a/packages/typescript-types/README.md
+++ b/packages/typescript-types/README.md
@@ -1,6 +1,28 @@
-# @simplewebauthn/typescript-types
+# @simplewebauthn/typescript-types <!-- omit in toc -->
![WebAuthn](https://img.shields.io/badge/WebAuthn-Simplified-blueviolet?style=for-the-badge&logo=WebAuthn)
[![npm (scoped)](https://img.shields.io/npm/v/@simplewebauthn/typescript-types?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@simplewebauthn/typescript-types)
TypeScript typings for **@simplewebauthn/server** and **@simplewebauthn/browser**
+
+- [Installation](#installation)
+ - [Node LTS 16.x or higher](#node-lts-16x-or-higher)
+ - [Deno v1.33.x or higher](#deno-v133x-or-higher)
+
+## Installation
+
+### Node LTS 16.x or higher
+
+This package is available on **npm**:
+
+```sh
+npm install @simplewebauthn/typescript-types
+```
+
+### Deno v1.33.x or higher
+
+It is also available for import into Deno projects from **deno.land/x**:
+
+```ts
+import {...} from 'https://deno.land/x/simplewebauthn/deno/typescript-types.ts';
+```