diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f60f11 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# go-cryptonym + +`go-cryptonym` is a tool that generates dissociated, natural, and neutral usernames with high entropy. Designed for applications needing unique, psuedorandom identifiers, it uses large wordlists (400 words, 350 modifiers, 100 syllables) and five strategies (syllable-based, word-based, invented word, mixed, phoneme-based) to ensure no discernable or repeatable username patterns. + +## Installation + +### Prerequisites + +- **Go**: Version 1.21 or later. +- **Make**: For building with the provided Makefile. +- **Git**: To clone the repository. + +### Steps + +- Clone the repository: + +``` +$ git clone https://cgit.heqnx.com/go-cryptonym +$ cd go-cryptonym +``` + +- Install dependencies: + +``` +$ go mod tidy +``` + +- Build for all platforms: + +``` +$ make all +``` + +- Binaries will be generated in the build/ directory for Linux, Windows, and macOS; alternatively, build for a specific platform: + +``` +$ make linux-amd64 +$ make windows-amd64 +$ make darwin-arm64 +``` + +## Usage + +### Command-Line Flags + +``` +Usage of ./go-cryptonym-linux-amd64: + -count int + number of usernames to generate (default 10) + -max-length int + maximum username length (default 12) + -min-length int + minimum username length (default 8) + -no-camelcase + disable camelcase styling + -no-numbers + disable appending numbers +``` + +## License + +This project is licensed under the GNU GENERAL PUBLIC LICENSE. See the LICENSE file for details. + +## Disclaimer + +`go-cryptonym` is provided "as is" without warranty. The author and contributors are not liable for any damages or legal consequences arising from its use. Use responsibly and only in authorized environments. |