Skip to content

Commit

Permalink
Update README.md (#3)
Browse files Browse the repository at this point in the history
Matches docs.aspect.build where we made these changes already.
  • Loading branch information
alexeagle authored Aug 14, 2024
1 parent aa176ef commit 94af8dc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
This is a plugin for the [Aspect CLI](https://aspect.build/cli).

It matches on error messages from Bazel, and adds extra information that can help your engineers
such as golinks to your internal documentation, tell them that a migration is underway with
such as go-links to your internal documentation, tell them that a migration is underway with
additional instructions, or whatever you can think of.

Users configure it in an `error_mappings` property in the `.aspect/cli/config.yaml` file in their repo.
Users configure it in an `error_mappings` property in the `.aspect/cli/config.yaml` file in their repository.

## Demo

Expand All @@ -22,4 +22,4 @@ plugins:
This plugin will print the message when the error contains "demo", like the following:
[![asciicast](https://asciinema.org/a/540385.svg)](https://asciinema.org/a/540385)
[![Plugin Demo Screencast](https://asciinema.org/a/540385.svg)](https://asciinema.org/a/540385)

0 comments on commit 94af8dc

Please sign in to comment.