diff options
| -rw-r--r-- | README.md | 23 |
1 files changed, 15 insertions, 8 deletions
@@ -1,5 +1,6 @@ <!-- omit in toc --> # SimpleWebAuthn Project +  [](https://www.npmjs.com/search?q=simplewebauthn) @@ -9,13 +10,15 @@ ## Overview -This monorepo contains two complimentary libraries to help reduce the amount of work needed to -incorporate WebAuthn into a website. The following packages are maintained here: +This monorepo contains two complimentary libraries to help reduce the amount of +work needed to incorporate WebAuthn into a website. The following packages are +maintained here: - [@simplewebauthn/server](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/server) - [@simplewebauthn/browser](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/browser) -An additional package is also included that contains shared TypeScript definitions: +An additional package is also included that contains shared TypeScript +definitions: - [@simplewebauthn/typescript-types](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/typescript-types/) @@ -23,11 +26,16 @@ See these packages' READMEs for more specific implementation information. **API Documentation** -In-depth documentation for all of the packages in this project is available here: https://simplewebauthn.dev/docs/ +In-depth documentation for all of the packages in this project is available +here: https://simplewebauthn.dev/docs/ ## Example -For a practical guide to implementing these libraries, take a look at the [example project](https://github.com/MasterKale/SimpleWebAuthn/tree/master/example). It includes a single-file Express server and a few HTML files that, combined with the packages in this repo, are close to all it takes to get up and running with WebAuthn. +For a practical guide to implementing these libraries, take a look at the +[example project](https://github.com/MasterKale/SimpleWebAuthn/tree/master/example). +It includes a single-file Express server and a few HTML files that, combined +with the packages in this repo, are close to all it takes to get up and running +with WebAuthn. ## Development @@ -35,7 +43,6 @@ After pulling down the code, set up dependencies: ```sh $> npm install -$> npm run bootstrap ``` To run unit tests for all tracked lerna packages, run the following: @@ -44,9 +51,9 @@ To run unit tests for all tracked lerna packages, run the following: $> npx lerna run test ``` -Running Jest in watch mode for a specific project requires the use of `lerna exec`: +Running Jest in watch mode for a specific project requires the use of +`lerna exec`: ```sh $> npx lerna exec npm run test:watch --scope=@simplewebauthn/server ``` - |