Skip to content

Commit 392b63f

Browse files
committed
update README
1 parent 26a6805 commit 392b63f

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The app identifies the commit where the search string appears, using an optimize
1616
- **Optimized Search**: Quickly identifies the commit where the search string first appears and last disappears.
1717
- **Searches Across Multiple File Types**: Search in Excel files (.xls, .xlsx) and text files (.txt, .sql, .cs, etc.).
1818
- **Log File**: Keeps track of all checked commits and results, allowing you to continue the search later.
19-
- **Commit Range**: Specify an earliest and latest commit to limit the search scope.
19+
- **Date Range**: Specify start and end dates to limit the search scope (with fallback to commit range in CLI).
2020
- **Follow File History**: Use the `--follow` option (CLI) or toggle in UI to follow file renames and history across commits.
2121

2222
## Download Windows Binaries
@@ -68,7 +68,7 @@ For easy access, you can create a shortcut to `GitContentSearch.UI.exe` on your
6868
1. Launch `GitContentSearch.UI.exe`
6969
2. Configure your Git repository settings
7070
3. Enter the file path and search string
71-
4. Optionally set commit range and other search options
71+
4. Set the date range using the date picker or enter dates manually (format: YYYY-MM-DD)
7272
5. Click Search to begin
7373

7474
### CLI Version
@@ -84,28 +84,30 @@ cd /path/to/your/git/repository
8484
**2. Run the tool**:
8585

8686
```bash
87-
GitContentSearch.exe <remote-file-path> <search-string> [--earliest-commit=<commit>] [--latest-commit=<commit>] [--working-directory=<path>] [--log-directory=<path>] [--follow]
87+
GitContentSearch.exe <remote-file-path> <search-string> [--start-date=<date>] [--end-date=<date>] [--earliest-commit=<commit>] [--latest-commit=<commit>] [--working-directory=<path>] [--log-directory=<path>] [--follow]
8888
```
8989

9090
### CLI Arguments
9191

9292
* `<file-path>`: The path to the Content file within the Git repository.
9393
* `<search-string>`: The string you want to search for in the Content file.
94-
* `--earliest-commit=<commit>`: (Optional) The earliest commit to begin the search.
95-
* `--latest-commit=<commit>`: (Optional) The latest commit to end the search.
94+
* `--start-date=<date>`: (Optional) The start date for the search (format: YYYY-MM-DD).
95+
* `--end-date=<date>`: (Optional) The end date for the search (format: YYYY-MM-DD).
96+
* `--earliest-commit=<commit>`: (Optional) The earliest commit to begin the search (takes precedence over date range if both are specified).
97+
* `--latest-commit=<commit>`: (Optional) The latest commit to end the search (takes precedence over date range if both are specified).
9698
* `--working-directory=<path>`: (Optional) The directory where Git commands should be executed. Defaults to the user's temp directory if not provided.
9799
* `--log-directory=<path>`: (Optional) The directory where the log file and temporary files will be stored. Defaults to the user's temp directory if not provided.
98100
* `--follow`: (Optional) Follow file renames and history across commits.
99101

100102
### CLI Example
101103

102104
```bash
103-
GitContentSearch.exe "path/to/your/file.xlsx" "SearchString" --earliest-commit=abc123 --latest-commit=def456 --working-directory="/your/git/repo" --log-directory="/your/log/directory" --follow
105+
GitContentSearch.exe "path/to/your/file.xlsx" "SearchString" --start-date="2023-01-01" --end-date="2023-12-31" --working-directory="/your/git/repo" --log-directory="/your/log/directory" --follow
104106
```
105107

106-
This will search for the string "SearchString" within the specified commit range, using the specified working directory for Git operations and storing logs and temporary files in the specified log directory.
108+
This will search for the string "SearchString" within the specified date range, using the specified working directory for Git operations and storing logs and temporary files in the specified log directory.
107109

108-
Note: The file is the remote path (e.g. `path/to/your/file.xlsx`), not the local path (e.g. `c:/repo/path/to/your/file.xlsx`).
110+
Note: The file is the remote path (e.g. `path/to/your/file.xlsx`), not the local path (e.g. `c:/repo/path/to/your/file.xlsx`). All dates are handled in UTC timezone.
109111

110112
## Output
111113

0 commit comments

Comments
 (0)