https://github.com/minvws/horsebattery

A password generator inspired by https://xkcd.com/936/
https://github.com/minvws/horsebattery

Last synced: about 1 month ago
JSON representation

A password generator inspired by https://xkcd.com/936/

• Host: GitHub
• URL: https://github.com/minvws/horsebattery
• Owner: minvws
• License: eupl-1.2
• Created: 2022-01-14T15:09:34.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-12T10:43:39.000Z (about 2 months ago)
• Last Synced: 2024-11-12T11:33:59.497Z (about 2 months ago)
• Language: PHP
• Size: 405 KB
• Stars: 8
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.pdf
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# HorseBattery password generator

A password generator based on [this XKCD comic](https://xkcd.com/936/). 

Provides a default word list in Dutch and will generate a password based on

the wordlist and a given number of words.

May be expanded to include other locales in the future or configuration to 

allow for other word lists.

## Requirements

- PHP >= 8.1

- Composer

## Installation

1. Install the package via composer:

  ```sh

  composer require minvws/horsebattery

  ```

# Usage

Generic usage

```php

$generator = new HorseBattery();

$password = $generator->generate(4);

// returns for instance: AandeelBijkomendeDereguleringHandelingen

```

# Running tests

You can run the tests by issuing the following command:

```Bash

$ composer run test

```

# Contributing

If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository of this package.

# License

This package is open-source and released under the European Union Public License version 1.2. You are free to use, modify, and distribute the package in accordance with the terms of the license.