![\"npm](\"https://badge.fury.io/js/silly-password-generator.svg\"){kind=icon}
\n ![\"View](\"https://img.shields.io/badge/GitHub-Source-success\"){kind=icon}
\n ![\"Deploy](\"https://github.com/justinmahar/silly-password-generator/workflows/Deploy/badge.svg\"){kind=icon}
\n\n \n \n
\n ![\"Buy](\"https://img.shields.io/static/v1?label=Buy%20me%20a%20coffee&message=%E2%9D%A4&logo=KoFi&color=%23fe8e86\")
![\"Sponsor\"/](\"https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86\")
![\"Sponsor](\"https://justinmahar.github.io/react-kindling/support/sponsor.png\")
![\"Buy](\"https://justinmahar.github.io/react-kindling/support/coffee-1.png\")
![\"Buy](\"https://justinmahar.github.io/react-kindling/support/coffee-3.png\")
![\"Buy](\"https://justinmahar.github.io/react-kindling/support/coffee-5.png\")
\n\n\n\n## Table of Contents \n\n- [Documentation](#documentation)\n - [→ Generate Silly Passwords ←](#-generate-silly-passwords-)\n- [Overview](#overview)\n - [Features include:](#features-include)\n- [Donate](#donate)\n- [Table of Contents](#table-of-contents)\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n - [Via Website](#via-website)\n - [Via npm](#via-npm)\n - [Analyzing Password Strength](#analyzing-password-strength)\n- [TypeScript](#typescript)\n- [Icon Attribution](#icon-attribution)\n- [Contributing](#contributing)\n- [⭐ Found It Helpful? Star It!](#-found-it-helpful-star-it)\n- [License](#license)\n\n## Installation\n\n```\nnpm i silly-password-generator\n```\n\n## Quick Start\n\n### Via Website\n\nGo here: [Silly Password Generator](https://justinmahar.github.io/silly-password-generator/?path=/story/tools--silly-password-generator)\n\n### Via npm\n\n```js\nimport { generateSillyPassword } from 'silly-password-generator';\n```\n\n```js\n// Use with no options to generate a 4-word silly password\ngenerateSillyPassword(); // `thorough loud annoying penguin`\n\n// Provide a custom word count if you'd like\ngenerateSillyPassword({ wordCount: 7 }); // `glamorous large powerful fast black noisy clam`\n\n// Capitalize the first letter of the resulting password\ngenerateSillyPassword({ capitalize: true }); // `Curious fluffy excited copperhead`\n\n// You can provide salt to strengthen your passwords, too. Salt is appended to the end.\ngenerateSillyPassword({ salt: \"!?!?\" }); // `damned important envious pangolin!?!?`\n```\n\n> Combine options as you see fit. The `wordCount` must be at least `1`.\n\n### Analyzing Password Strength\n\nThis library uses [zxcvbn](https://www.npmjs.com/package/zxcvbn) to analyze password strength. This was written by a bunch of nerds, so you know it's legit.\n\n```js\nimport { analyzePassword } from 'silly-password-generator';\n```\n\n```js\n// Returns an object telling you how awesome or crappy your password is.\nconst results = analyzePassword(sillyPassword); \n```\n\nSee the [zxcvbn Usage section](https://www.npmjs.com/package/zxcvbn#usage) for the properties available.\n\n\n\n## TypeScript\n\nType definitions have been included for [TypeScript](https://www.typescriptlang.org/) support.\n\n\n\n\n\n## Icon Attribution\n\nFavicon by [Twemoji](https://github.com/twitter/twemoji).\n\n\n\n\n\n## Contributing\n\nOpen source software is awesome and so are you. 😎\n\nFeel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.\n\nFor major changes, open an issue first to discuss what you'd like to change.\n\n\n\n## ⭐ Found It Helpful? [Star It!](https://github.com/justinmahar/silly-password-generator/stargazers)\n\nIf you found this project helpful, let the community know by giving it a [star](https://github.com/justinmahar/silly-password-generator/stargazers): [👉⭐](https://github.com/justinmahar/silly-password-generator/stargazers)\n\n\nWant to support the project? Feel free to grab me a coffee, which is my main source of fuel for development:\n\n \n\n\n\n## License\n\nSee [LICENSE.md](https://justinmahar.github.io/silly-password-generator/?path=/docs/license--docs).","readmeFilename":"README.md"}