diff --git a/README.md b/README.md index cc8ecc9..eeff119 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,23 @@ A Bash script to rename files in a directory by removing unsafe characters, hand ## ๐Ÿš€ Usage +### Fetch the script ```bash -# Clone the repo -git clone https://github.com/yourname/yourrepo.git -cd yourrepo +curl -fsSL -o rename_safe.sh https://git.r21.io/primemover/rename_safe/raw/branch/master/rename_safe.sh +``` -# Make the script executable +### Make the script executable +```bash chmod +x rename_safe.sh +``` -# Dry run (test mode) +### Dry run (test mode) +```bash ./rename_safe.sh --dry-run /path/to/files +``` -# Actual renaming +### Actual renaming +```bash ./rename_safe.sh /path/to/files ``` @@ -33,8 +38,18 @@ chmod +x rename_safe.sh ## ๐Ÿงช Test Script +### Fetch the script +```bash +curl -fsSL -o test_rename.sh https://git.r21.io/primemover/rename_safe/raw/branch/master/test_rename.sh +``` + +### Make the script executable +```bash +chmod +x test_rename.sh +``` + +### Run validation tests ```bash -# Run validation tests ./test_rename.sh ```