Skip to content

Commit

Permalink
docs: update docs with new packages (#848)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrexox authored Oct 17, 2024
1 parent 75be8c8 commit 49d6383
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<img align="right" width="147" height="100" title="Lefthook logo"
src="./logo_sign.svg">

A Git hooks manager for Node.js, Ruby and many other types of projects.
A Git hooks manager for Node.js, Ruby, Python and many other types of projects.

* **Fast.** It is written in Go. Can run commands in parallel.
* **Powerful.** It allows to control execution and files you pass to your commands.
Expand All @@ -33,12 +33,18 @@ With **NPM**:
npm install lefthook --save-dev
```

With **Ruby**:
For **Ruby**:

```bash
gem install lefthook
```

For **Python**:

```bash
pip install lefthook
```

**[Installation guide](./docs/install.md)** with more ways to install lefthook: [apt](./docs/install.md#deb), [brew](./docs/install.md#homebrew), [winget](./docs/install.md#winget), and others.

## Usage
Expand Down
20 changes: 15 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Choose your fighter:
- [Snap](#snap)
- [Debian-based distro](#deb)
- [RPM-based distro](#rpm)
- [Alpine](#alpine)
- [Arch Linux](#arch)
- [Manual](#else)

Expand Down Expand Up @@ -63,15 +64,13 @@ Lefthook is available on NPM in the following flavors:
## <a id="go"></a> Go

```bash
go get github.com/evilmartians/lefthook
go install github.com/evilmartians/lefthook@latest
```

## <a id="python"></a> Python

You can find Python wrapper here [package](https://github.com/life4/lefthook)

```sh
python3 -m pip install --user lefthook
python -m pip install --user lefthook
```

## <a id="swift"></a> Swift
Expand Down Expand Up @@ -120,7 +119,6 @@ snap install --classic lefthook
curl -1sLf 'https://dl.cloudsmith.io/public/evilmartians/lefthook/setup.deb.sh' | sudo -E bash
sudo apt install lefthook
```

See all instructions: https://cloudsmith.io/~evilmartians/repos/lefthook/setup/#formats-deb

[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=flat-square)](https://cloudsmith.com "Debian package repository hosting is graciously provided by Cloudsmith")
Expand All @@ -136,6 +134,18 @@ See all instructions: https://cloudsmith.io/~evilmartians/repos/lefthook/setup/#

[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=flat-square)](https://cloudsmith.com "RPM package repository hosting is graciously provided by Cloudsmith")

## <a id="alpine"></a> APK packages for Alpine

```sh
sudo apk add --no-cache bash curl
curl -1sLf 'https://dl.cloudsmith.io/public/evilmartians/lefthook/setup.alpine.sh' | sudo -E bash
sudo apk add lefthook
```

See all instructions: https://cloudsmith.io/~evilmartians/repos/lefthook/setup/#formats-alpine

[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=flat-square)](https://cloudsmith.com "RPM package repository hosting is graciously provided by Cloudsmith")

## <a id="arch"></a> AUR for Arch

You can install lefthook [package](https://aur.archlinux.org/packages/lefthook) from AUR.
Expand Down

0 comments on commit 49d6383

Please sign in to comment.