]> git.ardis.lu - seed-phrase-transposer/commitdiff
Add "Usage" section
authorArdis Lu <ardisglu@gmail.com>
Sat, 8 Jun 2024 21:05:59 +0000 (14:05 -0700)
committerArdis Lu <ardisglu@gmail.com>
Sat, 8 Jun 2024 21:05:59 +0000 (14:05 -0700)
README.md

index e73e3088d72be3371d1e89302c18c7b3686744d7..facd3fa73edda5d4a4f49e958f92c5abb92727b7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -49,6 +49,32 @@ Seed phrase: 1 4 7 10 2 5 8 11 3 6 9 12
 1 10 8 6 4 2 11 9 7 5 3 12
 ```
 
+## Usage
+
+Clone this repo and run `main.ts`:
+
+```
+> deno run main.ts
+Seed phrase:
+```
+
+Or you can directly run `main.ts` from its raw GitHub URL:
+
+```
+> deno run https://raw.githubusercontent.com/ardislu/seed-phrase-transposer/main/main.ts
+Seed phrase:
+```
+
+Or install `main.ts` globally and use it as a more typical CLI:
+
+```
+> deno install --global --name spt https://raw.githubusercontent.com/ardislu/seed-phrase-transposer/main/main.ts
+✅ Successfully installed spt
+
+> spt
+Seed phrase:
+```
+
 ## Security
 
 This CLI is completely self-contained and does not require any file, network, or
This page took 0.035106 seconds and 4 git commands to generate.