Skip to content

Commit 360c5ca

Browse files
docs: update README installation instructions and fix branch references
1 parent 82e350d commit 360c5ca

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,34 @@
11
# CNKill
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/abdelhamiderrahmouni/cnkill.svg?style=flat-square)](https://packagist.org/packages/abdelhamiderrahmouni/cnkill)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/abdelhamiderrahmouni/cnkill/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/abdelhamiderrahmouni/cnkill/actions?query=workflow%3Arun-tests+branch%3Amain)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/abdelhamiderrahmouni/cnkill/run-tests.yml?branch=master&label=tests&style=flat-square)](https://github.com/abdelhamiderrahmouni/cnkill/actions?query=workflow%3Arun-tests+branch%3Amaster)
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/abdelhamiderrahmouni/cnkill/pint.yml?branch=master&label=code%20style&style=flat-square)](https://github.com/abdelhamiderrahmouni/cnkill/actions?query=workflow%3A"pint"+branch%3Amaster)
66
[![Total Downloads](https://img.shields.io/packagist/dt/abdelhamiderrahmouni/cnkill.svg?style=flat-square)](https://packagist.org/packages/abdelhamiderrahmouni/cnkill)
77

88
A Blazing Fast, Interactive TUI tool (like `npkill`) to find and delete `vendor/` and `node_modules/` directories in your old projects — freeing up disk space fast.
99

1010
## Installation && Update
11+
We provide multiple installation methods to suit your preferences. The recommended way is the standalone executable for Linux and macOS.
1112

12-
Quick install (Linux/macOS, no system PHP required):
13+
1. Quick install (Linux/macOS, standalone executable):
1314

1415
```bash
15-
curl -fsSL https://raw.githubusercontent.com/abdelhamiderrahmouni/cnkill/main/install.sh | sh
16+
curl -fsSL https://raw.githubusercontent.com/abdelhamiderrahmouni/cnkill/master/install.sh | sh
1617
```
1718

18-
System-wide install (requires sudo):
19+
2. System-wide install (requires sudo):
1920

2021
```bash
21-
curl -fsSL https://raw.githubusercontent.com/abdelhamiderrahmouni/cnkill/main/install.sh | sh -s -- --system
22+
curl -fsSL https://raw.githubusercontent.com/abdelhamiderrahmouni/cnkill/master/install.sh | sh -s -- --system
2223
```
2324

24-
Install globally via Composer:
25+
3. Install via cpx (the npx for PHP):
26+
27+
```bash
28+
cpx abdelhamiderrahmouni/cnkill
29+
```
30+
31+
4. Install globally via Composer:
2532

2633
```bash
2734
composer global require abdelhamiderrahmouni/cnkill

0 commit comments

Comments
 (0)