docs: update readme

flexwie · Dec 12, 2024 · e731ee1 · e731ee1
1 parent 2a4d948
commit e731ee1
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 A npx-like script runner for GitHub gists
 
-Fetch scripts from GitHub Gists and execute them as if they were native scripts.
+Fetch scripts from GitHub Gists and execute them as if they were native scripts. Uses the GitHub CLI for authentication under the hood.
 
 ## Installation
 
@@ -29,10 +29,10 @@ You can get a nix flake from https://github.com/flexwie/nur-packages
 ## Usage
 
 ```sh
-ghs <user>/<gist>
+ghs [<user>/]<gist>
 ```
 
-for example: `ghs flexwie/test.sh`
+for example: `ghs flexwie/test.sh`. If no username is provided, the currently logged in user will be assumed.
 
 ## Executors