Add README

This commit is contained in:
Tim Van Baak 2022-12-13 13:49:42 -08:00
parent 9c5ed994ea
commit d8384df003
1 changed files with 11 additions and 0 deletions

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# friendly-hex
Hexadecimal strings are, strictly speaking, human-readable, but they are very information-dense, which makes them hard to grok at a glance or read quickly. `friendly-hex` is a tool to make short hexadecimal strings, such as git revisions, more readable by mapping digits and digit pairs to English words. You may already be familiar with this kind of cipher, such as is used in Giphy image identifiers.
Try it out in your local git repo:
```
$ nix run github:Jaculabilis/friendly-hex -- -x $(git rev-parse --short HEAD)
popular guessing struggle nine
```