From 49d6383c7bb3b29010a657941999ca5614a72f13 Mon Sep 17 00:00:00 2001 From: Valentin Kiselev Date: Thu, 17 Oct 2024 13:17:50 +0300 Subject: [PATCH] docs: update docs with new packages (#848) --- README.md | 10 ++++++++-- docs/install.md | 20 +++++++++++++++----- 2 files changed, 23 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 66fb73b5..1ecf8926 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ -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. @@ -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 diff --git a/docs/install.md b/docs/install.md index 7aae62a2..c90e75a4 100644 --- a/docs/install.md +++ b/docs/install.md @@ -13,6 +13,7 @@ Choose your fighter: - [Snap](#snap) - [Debian-based distro](#deb) - [RPM-based distro](#rpm) +- [Alpine](#alpine) - [Arch Linux](#arch) - [Manual](#else) @@ -63,15 +64,13 @@ Lefthook is available on NPM in the following flavors: ## Go ```bash -go get github.com/evilmartians/lefthook +go install github.com/evilmartians/lefthook@latest ``` ## 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 ``` ## Swift @@ -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") @@ -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") +## 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") + ## AUR for Arch You can install lefthook [package](https://aur.archlinux.org/packages/lefthook) from AUR.