Skip to content

chore: fix docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pixincreate merged 1 commit into from
Feb 16, 2025
Merged

chore: fix docs #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ KeyWatch/
└── integration_tests.rs // Integration tests for end-to-end functionality.
```

# <<<<<<< Updated upstream

The relationships between key modules are illustrated below:

```mermaid
Expand Down Expand Up @@ -134,14 +132,11 @@ You can install KeyWatch globally so it is available from any command prompt:
```ps1
Copy-Item -Path "key-watch.exe" -Destination "C:\Program Files\KeyWatch\key-watch.exe"
```

> [!TIP]
> You can also add the `–Force` parameter if you want to overwrite the destination file without any prompts

You can also add the `–Force` parameter if you want to overwrite the destination file without any prompts

3. Alternatively, you can add `%USERPROFILE%\.cargo\bin` to your system `PATH` if it’s not already included. This is where Cargo installs binaries by default.

> > > > > > > Stashed changes

## Usage

### Scanning Files and Directories
Expand Down Expand Up @@ -213,8 +208,8 @@ Integrate KeyWatch into your development workflow by setting it up as a pre-comm
pip install pre-commit
```

> [!NOTE]
> Make sure that you have the `pre-commit` binary in your PATH.
> [!NOTE]
> Make sure that you have the `pre-commit` binary in your PATH.

2. **Create the Hook Script:**

Expand Down
Loading