Skip to content

Add 'See it in action' demo to README #28

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
Byggarepop merged 1 commit into from
Jul 29, 2026
Merged

Add 'See it in action' demo to README #28

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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,22 @@ dotnet tool execute Unwritten --yes -- install-hook --git --claude-code
That's it — your agent can now call `check_holes` after editing, and the hooks
catch the cases where it forgets to.

## See it in action

Checking stats of the index shows 1 pair that goes above the 0.7 rule:

![Checking stats of index](https://raw.githubusercontent.com/Byggarepop/Unwritten/main/img/demo/check-index.png)

Checking stats after a change has been made to one of the files. The tool
informs that there is one file with a confidence score above 0.7 that is not
changed together with its pair, and shows 3 ways to resolve the issue:

![Checking stats for a hole after change](https://raw.githubusercontent.com/Byggarepop/Unwritten/main/img/demo/check-stats.png)

Installing the pre-commit hook gives the same output:

![Using pre-commit hook to check for holes](https://raw.githubusercontent.com/Byggarepop/Unwritten/main/img/demo/use-pre-commit-hook.png)

## Documentation

Everything else lives in **[docs/README.md](https://github.com/Byggarepop/Unwritten/blob/main/docs/README.md)**:
Expand Down
Loading