From 8574649b915ea0ca8f9c924f9d86669f8554ba58 Mon Sep 17 00:00:00 2001 From: MrWook Date: Tue, 1 Oct 2024 16:03:35 +0200 Subject: [PATCH] docs(build): remove mentioning of browser build --- docs/guide/getting-started/README.md | 37 ++-------------------------- 1 file changed, 2 insertions(+), 35 deletions(-) diff --git a/docs/guide/getting-started/README.md b/docs/guide/getting-started/README.md index 8cb60abc..204eebf7 100644 --- a/docs/guide/getting-started/README.md +++ b/docs/guide/getting-started/README.md @@ -33,39 +33,6 @@ const zxcvbn = new ZxcvbnFactory(options) zxcvbn.check(password) ``` -### As script tag - -Example using jsdelivr (a CDN) - -```html - - - - - - - - - - -``` - ## Output ``` @@ -144,15 +111,15 @@ If you want to use it and want to include your own polyfills, you need to transp - I18n support for feedback, dictionaries and keyboard patterns. By default, the feedback are keys now - All dictionaries are optional, but the `en` dictionary is highly recommend (wished feature in some issues) - Dictionaries are separate from the core library. This means zxcvbn-ts is relatively small without its dictionaries +- compress dictionaries for smaller bundle size => up to 33% smaller dictionaries while having more entries - The project is a monorepo with a core library `@zxcvbn-ts/core` and language packages `@txcvbn-ts/language-en`. - Initially, there are only German and English language packages. - Keyboard layouts can be customised. This means you can overwrite the default set of layouts with your own or extend it. E.g., if you are developing a Russian website, you need to include a Cyrillic keyboard set. Create a PR so that others can benefit from it. - You can use multiple keyboard layouts, which means that the library will check against them by default. - the tests are Jest based, so we get a coverage score - eslint/prettier for consistent code style - Added static page docs https://zxcvbn-ts.github.io/zxcvbn/ -- esm, commonJS and browser build +- esm, commonJS - Custom matcher can be added which means you can create your own matcher - Async matcher can be added which means you can create a matcher that makes an API call - [haveibeenpwned](https://haveibeenpwned.com/Passwords) matcher