From dbd29c734d82b21be2b56409471be24fa897d182 Mon Sep 17 00:00:00 2001 From: Ardis Lu Date: Sat, 27 Jan 2024 17:53:09 -0800 Subject: [PATCH] Use concise language --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d327176..c4e6ab4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # seed-phrase-transposer -This is a simple [Deno](https://deno.land/) CLI to print possible permutations -of a seed phrase to help test if a transposition error occurred while the seed -phrase was recorded. +This is a simple [Deno](https://deno.land/) CLI that prints permutations of a seed phrase to help test if a transposition error occurred while the seed phrase was recorded. ## Background @@ -12,11 +10,10 @@ phrases are ubiquitous in crypto. However, due to the length of the seed phrase, they're often presented to users in a grid. Sometimes bad wallet UIs do not number the words, [making the order of the words ambiguous](https://knowyourmeme.com/memes/dont-dead-open-inside) -and thus introducing the risk of a user recording the words in the wrong order +and introducing the risk of a user recording the words in the wrong order (a transposition error). -This tool is intended to show possible permutations of a seed phrase when read -from ambiguous grid layouts to assist with testing and potential recovery. +This tool is intended to show permutations of a seed phrase when read from ambiguous grid layouts to assist with testing and potential recovery. ## Example @@ -36,8 +33,7 @@ incorrectly record these numbers top-to-bottom, left-to-right. Like this: 1 4 7 10 2 5 8 11 3 6 9 12 ``` -This CLI will output possible permutations of the input, enabling a user to -quickly discover the correct one: +This CLI will output permutations of the input, helping a user discover the correct one: ``` > deno run main.ts -- 2.47.3