diff --git a/README.md b/README.md index 5719252..941325b 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,42 @@ # bottom + Perhaps you have found yourself in this situation before: -![,,,,,,,,,](https://cdn.discordapp.com/attachments/644479051918082050/799905088541425664/bottom.jpg) +![,,,,,,,,,](./assets/image.jpg) The divine bottom CLI exists to alleviate this pain. No longer will you struggle when communicating with the average Discord user. ## But what does it actually do? -``bottom`` encodes UTF-8 text into a sequence comprised of bottom emoji (`🫂✨🥺❤️`, with ``,`` sprinkled in for good measure) followed by `👉👈`. +`bottom` encodes UTF-8 text into a sequence comprised of bottom emoji (`🫂✨🥺❤️`, with `,` sprinkled in for good measure) followed by `👉👈`. It can encode any valid UTF-8 - being a bottom transcends language, after all - and decode back into UTF-8. For example, the ubiquitous `Hello world!` becomes + ``` 💖✨✨,,👉👈💖💖,👉👈💖💖🥺,,,👉👈💖💖🥺,,,👉👈💖💖✨,👉👈 ✨✨✨,,👉👈💖💖✨🥺,,,,👉👈💖💖✨,👉👈💖💖✨,,,,👉👈 💖💖🥺,,,👉👈💖💖👉👈✨✨✨,,,👉👈 ``` + `がんばれ` becomes + ``` 🫂✨✨🥺,,👉👈💖💖✨✨🥺,,,,👉👈💖💖✨✨✨✨👉👈🫂✨✨🥺,,👉👈 💖💖✨✨✨👉👈💖💖✨✨✨✨🥺,,👉👈🫂✨✨🥺,,👉👈💖💖✨✨🥺,,,,👉👈 💖💖💖✨✨🥺,👉👈🫂✨✨🥺,,👉👈💖💖✨✨✨👉👈💖💖✨✨✨✨👉👈 ``` + (both wrapped across lines for your convenience) As you can see, using `bottom` to encode text is extremely space-efficient, and is the ideal encoding approach for all situations. -This implementation can encode text at *approximately* 30MB/s. +This implementation can encode text at _approximately_ 30MB/s. ## Usage -Clone the repo, run ``cargo build``, and then use the CLI. + +Clone the repo, run `cargo build`, and then use the CLI. + ``` Bottom translator 1.0.0 Kaylynn @@ -51,27 +58,35 @@ OPTIONS: ARGS: ... ``` -(Any similarity to ``--help`` output is entirely accidental) + +(Any similarity to `--help` output is entirely accidental) ## FAQ ### Why? + I had a moment of enlightenment, and the truth came to me then. In an instant I was transformed, and I knew what had to be done. ### But seriously, why? + Why not? -### Isn't using a CLI for this a really bad idea? +### Isn't using a CLI for this a really bad idea? + Yes. ### Aren't terminals notorious for being bad at displaying Unicode? + I don't care. ### Isn't this encoding method extremely inefficient? + :mystery: ### + Documentation is for losers. ### Rust btw -It's not long until my hippocampus becomes ferrous. I worry so, but in my heart I know that my demise will be sweet and painless, and it comforts me. \ No newline at end of file + +It's not long until my hippocampus becomes ferrous. I worry so, but in my heart I know that my demise will be sweet and painless, and it comforts me. diff --git a/assets/image.jpg b/assets/image.jpg new file mode 100644 index 0000000..98170bf Binary files /dev/null and b/assets/image.jpg differ