Skip to content

Commit

Permalink
docs: add installation instructions on top
Browse files Browse the repository at this point in the history
And fix the instructions itself...
  • Loading branch information
Nr18 committed Sep 20, 2023
1 parent 2498811 commit f761c0c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,18 @@ This could lead into resources being in a non-compliant state. The `aws-iam-user

More information can be found on the [documentation pages](https://conijnio.github.io/aws-iam-user/).

## Installation

You can install the tool with the following command:

```shell
brew tap conijnio/aws-iam-user
brew install aws-iam-user
```

## Prerequisites

You will need to install the following tools to successfully run the make targets:
You will need to install the following tools to successfully run the make targets listed below:

```shell
go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
Expand All @@ -40,15 +49,6 @@ pre-commit install
- `make lint`, performs linting actions on the codebase.
- `make test`, runs all the unit tests.

## Installation

You can install the tool with the following command:

```sh
brew tap conijnio/aws-iam-user
git fetch --porune
```

## License

This project is free and open source software licensed under the [Apache 2.0 License](./LICENSE).

0 comments on commit f761c0c

Please sign in to comment.