Skip to content

Commit

Permalink
Update readme with install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Mozzo1000 committed Sep 6, 2024
1 parent 3c5dd9b commit 9955648
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# brkn-lnk
brkn-lnk (broken link) is a link checker

# Install
>[!NOTE]
> Binaries are only provided for Windows.
>
> The software has only been tested on Windows 11 but may work on other platforms if built from source.
1. Download latest release from the [releases page](https://github.com/Mozzo1000/brkn-lnk/releases)
2. Save the .exe file in a folder of your choosing.
3. Edit your PATH environment variable to point to the folder that contains the .exe file.
1. See https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/ for how to edit PATH.

# Usage
## Check single url
Expand Down

0 comments on commit 9955648

Please sign in to comment.