https://github.com/sunsided/angrypurpletiger

animal-based hash digests for humans ... in C#
https://github.com/sunsided/angrypurpletiger

dotnet hashing helium human-readable-representations nuget-package

Last synced: 13 days ago
JSON representation

animal-based hash digests for humans ... in C#

• Host: GitHub
• URL: https://github.com/sunsided/angrypurpletiger
• Owner: sunsided
• License: apache-2.0
• Created: 2023-02-05T16:41:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-10T10:57:56.000Z (about 1 year ago)
• Last Synced: 2024-12-03T04:34:53.698Z (about 1 month ago)
• Topics: dotnet, hashing, helium, human-readable-representations, nuget-package
• Language: C#
• Homepage: https://www.nuget.org/packages/AngryPurpleTiger
• Size: 37.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Angry Purple Tiger

animal-based hash digests for humans ... in C# — a port of [helium/angry-purple-tiger-rs](https://github.com/helium/angry-purple-tiger-rs).

## Overview

Angry Purple Tiger generates animal-based hash digests meant to be memorable

and human-readable. Angry Purple Tiger is apt for anthropomorphizing project

names, crypto addresses, UUIDs, or any complex string of characters that

needs to be displayed in a user interface.

```shell

dotnet add package AngryPurpleTiger --version 0.1.0

```

## Example

```csharp

using AngryPurpleTiger;

var digest = AnimalName.FromString("my ugly input string");

Console.WriteLine(digest);

//=> Rapid Grey Rattlesnake

```

## Notes

The algorithm is known to produce more `Short Raccoons` than other animals.

The word lists provided by the upstream implementation(s) contain duplicates

of the adjectives `skinny`, `long`, `short`, `hot`, `cool` and `tangy`, 

as well as the animal `raccoon`.  In addition, the words `swift` and `mammoth`

act as both animals and adjectives, while `tiger` serves as both animal and color.

This should not affect the usability of the library but care needs to be taken

when assuming the number of possible combinations.

## License

Apache 2.0 © 2023 Markus Mayer; © 2018 Helium Systems, Inc.

This library is a port of [helium/angry-purple-tiger](https://github.com/helium/angry-purple-tiger) and 

[helium/angry-purple-tiger-rs](https://github.com/helium/angry-purple-tiger-rs), both of

which are released under the Apache-2.0 license. See the [LICENSE](LICENSE)

file for more information.