From e6e3df36e701472038dbd1872728bb27fa339083 Mon Sep 17 00:00:00 2001
From: caleb <16196262+spookyuser@users.noreply.github.com>
Date: Thu, 2 Jan 2025 14:54:54 +0200
Subject: [PATCH] Update readme

---
 README.md | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index fb36603..e2e8976 100644
--- a/README.md
+++ b/README.md
@@ -4,18 +4,12 @@ a cli to find and remove links that might annoy the chrome web store team
 
 often these are firebase links for some reason
 
-## Usage
+# Usage
 
-- `npx badlinks <folder>` to scan
-- `npx badlinks <folder> -r` to remove
+`npx badlinks <folder_or_file>` -- recursively search .js files in a folder for bad links
 
-```
-Usage: bad firebase links <folder> [options]
+For more options run `npx badlinks --help`
 
-Arguments:
-  folder        Folder to find JS links in
+# Contributing
 
-Options:
-  -r, --remove  Remove the JS links
-  -h, --help    display help for command
-```
+Yes!