@password-generator/package

Welcome to password-generator-package 👋

🚧 password-generator-package in production... 🚧

Package with the algorithm to generate passwords

🔖 Table Of Contents

• 📃 About
• 🤔 How To Use
• 🚀 Technologies
• 🌱 Minimal Requirements
• 🎇 Features
• 💡 How To Contribute
• 🤗 Contributors
• 👤 Author
• 🔏 License

---

📃 About

This package contains the password generation algorithm, it was created for code reuse and easy maintenance!

Back To The Top

---

🤔 How To Use

💻 Desktop

Install package with you package-manager

yarn add @password-generator/package

Import and execute

import { generatePassword, Preferences } from '@password-generator/package'

const preferences: Preferences = {
  length: 9,
  initialText: 'abc',
  cases: {
    pronounceable: false,
    uppercase: true,
    lowercase: true,
    numbers: true,
    symbols: true,
  },
}

try {
  const password = generatePassword(preferences);
  console.log(password);
} catch (error) {
  console.error(error.message)
}

Back To The Top

---

🚀 Technologies

• Typescript
• Node

Back To The Top

---

🌱 Minimal Requirements

• NodeJs

Back To The Top

---

🎇 Features

• [x] Create algorithm
• [x] Finish ambient config
• [x] Create actions in repository

Back To The Top

---

💡 How To Contribute

• Make a fork of this repository
• Clone to you machine and entry on respective paste
• Create a branch with your resource: git checkout -b my-feature
• Commit your changes: git commit -m 'feat: My new feature'
• Push your branch: git push origin my-feature
• A green button will appear at the beginning of this repository
• Click to open and fill in the pull request information

Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project

Back To The Top

---

🤗 Contributors

Back To The Top

---

👤 Author

🤓 Mikael Rolim de Aquino [e-mail]

• Github: @Mikael-R

Back To The Top

---

🔏 License

Copyright © 2020 Mikael Rolim de Aquino [e-mail]

This project is licensed by MIT License.

Back To The Top

---

This README was generated with 💟 by readme-template-generator