search

bbusschots / hsxkpasswd

A Perl module and terminal command for generating secure memorable passwords inspired by the fabulous XKCD web comic and Steve Gibson's Password Hay Stacks. This is the library that powers www.xkpasswd.net
http://www.bartb.ie/xkpasswd
BSD 2-Clause "Simplified" License
278 stars 48 forks source link

Improve documentation and provide a sample configuration file #12

Open bknowles opened 9 years ago

bknowles commented 9 years ago

So, I want to provide my own dictionary. And I want my own version of a password preset. In fact, I want to be able to create multiple presets of my own.

But I have no idea what a configuration file should look like, or how I would put it somewhere that it would get used by default.

The Perl POD documentation is pretty extensive, but I'd like to see more of that brought into the man page and into the README.md file for this repo. But even the Perl POD documentation doesn't show me how to create a configuration file or where I could put it so that it would get used by default.

bbusschots commented 9 years ago

@bknowles - until I get a chance to update the docs, there is a sample config file included in the share folder of the distro: https://github.com/bbusschots/hsxkpasswd/blob/master/share/sample_hsxkpasswdrc

bknowles commented 9 years ago

Cool. I'll take a look. Thanks!

et304383 commented 8 years ago

+1 on adding an example configuration file to the readme.