Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
suzuki-shunsuke committed Sep 7, 2021
1 parent f72bb37 commit 73f626e
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## How to use

[Example](aqua.yaml)
[Example](https://github.com/suzuki-shunsuke/my-aqua-config/blob/main/aqua.yaml)

aqua.yaml

Expand All @@ -14,6 +14,35 @@ registries:
ref: v0.3.0 # renovate: depName=suzuki-shunsuke/aqua-registry
```
## Search packages from the Standard Registry by the command `aqua g`

Please add the Standard Registry to your aqua.yaml's registries, and run `aqua g`.

```yaml
registries:
- type: standard
ref: v0.3.0 # renovate: depName=suzuki-shunsuke/aqua-registry
```

`aqua g` launches the interactive UI and you can search the package by fuzzy search.

```
direnv (standard)
consul (standard)
conftest (standard)
> golangci-lint (standard)
47/47
>
```
## Request for new packages
Please check [registry.yaml](https://github.com/suzuki-shunsuke/aqua-registry/blob/main/registry.yaml) or search packages by `aqua g` command.
If the packages you want aren't found, please create issues or send pull requests!
By adding various packages to the standard registry, aqua becomes more useful and attractive.
We need your contribution!
## How to contribute
Please see [CONTRIBUTING.md](CONTRIBUTING.md)
Expand Down

0 comments on commit 73f626e

Please sign in to comment.