Skip to content

Commit

Permalink
docs: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
mgred committed Aug 2, 2024
1 parent 69c426f commit 4040755
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
# Bzlparty Tools
# tools

[![Test](https://github.com/bzlparty/tools/actions/workflows/test.yaml/badge.svg?branch=main&event=push)](https://github.com/bzlparty/tools/actions/workflows/test.yaml)
[![Release](https://img.shields.io/github/v/release/bzlparty/tools?label=Release)](https://github.com/bzlparty/tools/releases/latest)

Functionality and tooling used in bzlparty rulesets.
Functionality and tooling used in bzlparty projects.

## Overview

This package provides several toolchains and rules that might be useful to set up bzlparty projects.

### Toolchains

The toolchains bundled into this module:

- [biome](https://github.com/biomejs/biome)
- [fd](https://github.com/sharkdp/fd)
- [goawk](https://github.com/benhoyt/goawk)
- [ripgrep](https://github.com/BurntSushi/ripgrep)
- [sha](/cmd/sha)
- [shellcheck](https://github.com/koalaman/shellcheck)
- [shellspec](https://github.com/shellspec/shellspec)
- [templ](/cmd/templ)
- [typos](https://github.com/crate-ci/typos)

## Installation

Expand Down

0 comments on commit 4040755

Please sign in to comment.