Skip to content

Commit

Permalink
chore: Further README fixups
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Lilley Brinker <[email protected]>
  • Loading branch information
alilleybrinker committed Jun 18, 2024
1 parent 68924d8 commit bdd7384
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Hipcheck &#x2713;

[![License: Apache-2.0](https://img.shields.io/github/license/mitre/hipcheck)](https://github.com/mitre/hipcheck/blob/main/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/mitre/hipcheck)](https://github.com/mitre/hipcheck/releases/latest)
[![Hipcheck Website](https://img.shields.io/badge/Hipcheck%20Website-blue)][website]
[![License: Apache-2.0](https://img.shields.io/github/license/mitre/hipcheck)][license]
[![GitHub Release](https://img.shields.io/github/v/release/mitre/hipcheck)][release]

__Go from hundreds of dependencies you can't review, to just a few you can!__

Expand All @@ -19,9 +20,9 @@ picture of the risk from using a package.

## Very Quick Explanation

- You'd like to use an open source software package, but you want to assess it.
- You'd like to use `express` an open source software package, but you want to assess it first.
- Run `hc check -t npm express`.
- If Hipcheck says "investigate," use Hipcheck's output to guide you.
- If Hipcheck says "investigate," use Hipcheck's output to guide a manual review of the package.

## Values

Expand All @@ -35,13 +36,13 @@ Read more about Hipcheck's product and project values in [RFD #2][rfd_2].

## Installation

__If installing locally:__ run the install script from the [latest release][latest_release],
__If installing locally:__ run the install script from the [latest release][release],
then run __`hc setup`__.

__If running as a container:__ use a [Hipcheck image from
Docker Hub][docker].

For alternative installation options, check out the [installation documentation][install_docs].
For alternative installation options, check out the [installation documentation][install].

## License

Expand All @@ -58,11 +59,11 @@ the [`LICENSE`](LICENSE) file in this repository.
> Computer Software and Noncommercial Computer Software Documentation Clause DFARS
> 252.227-7014 (FEB 2014)][dfars].
[react]: https://github.com/facebook/react
[install_rust]: https://www.rust-lang.org/tools/install
[install_node]: https://nodejs.org/en/learn/getting-started/how-to-install-nodejs
[rfd_2]: https://github.com/mitre/hipcheck/blob/main/docs/rfds/0002-hipchecks-values.md
[latest_release]: https://github.com/mitre/hipcheck/releases/latest
[docker]: https://hub.docker.com/r/mitre/hipcheck
[install_docs]: #

[dfars]: https://www.acquisition.gov/dfars/252.227-7014-rights-other-commercial-computer-software-and-other-commercial-computer-software-documentation.
[docker]: https://hub.docker.com/r/mitre/hipcheck
[install]: https://mitre.github.io/hipcheck/install
[license]: https://github.com/mitre/hipcheck/blob/main/LICENSE
[release]: https://github.com/mitre/hipcheck/releases/latest
[rfd_2]: https://mitre.github.io/hipcheck/rfds/0002
[website]: https://mitre.github.io/hipcheck
Binary file removed docs/assets/logo-transparent.png
Binary file not shown.
Binary file removed docs/assets/logo.png
Binary file not shown.

0 comments on commit bdd7384

Please sign in to comment.