Skip to content

Commit

Permalink
docs: link to live preview. (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii authored Jun 6, 2023
1 parent f99da0f commit 51bf1b0
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@

This is a framework for building checks designed to check to see if a
repository follows guidelines. By itself, it does nothing - it requires at
least one plugin to be installed..
least one plugin to be installed.

With one or more plugins, it will produce a list of results - green checkmarks
mean this rule is followed, red x’s mean the rule is not. A yellow warning sign
means that the check was skipped because a previous required check failed.

`sp-repo-review` provides checks based on the
[Scientific-Python Development Guide][] at [scientific-python/cookie][].
[Scientific-Python Development Guide][] at [scientific-python/cookie][]. A live
WebAssembly demo using `sp-repo-review` is
[here](https://scientific-python.github.io/repo-review).

## Running repo-review

Expand Down

0 comments on commit 51bf1b0

Please sign in to comment.