Skip to content

Commit c17a4e4

Browse files
committed
📝 add way to install
1 parent 2968005 commit c17a4e4

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed

README.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,58 @@
22

33
:zap: PHP version manager written in rust
44

5-
## :sparkles: Features
5+
## Features
66

77
- No requirements for system PHP installation
88
- Cross-platform support (macOS, Linux)
9-
- Automatically version switching with `.php-version`
9+
- Automatically version switching via `.php-version`
1010

11-
## :wrench: Installation
11+
## Installation
1212

13-
### shell setup
13+
### Requirements
1414

15-
#### Bash or Zsh
15+
- OS: Unix-like (Linux, macOS, BSD)
16+
- shell: bash, zsh
17+
- `curl`/`ps` instalation
18+
19+
### Manually
20+
21+
#### using a release binary
22+
23+
1. Download the [latest release binary](https://github.com/masan4444/phpup/releases) for your system
24+
2. Make it available globally on `PATH` environment variable
25+
26+
#### using cargo
27+
28+
```
29+
cargo install phpup
30+
```
31+
32+
### Shell setup
1633

1734
Add the following to your `.bashrc` or `.zshrc`
1835

1936
```bash
20-
eval "$(phpup init)"
37+
eval "$(phpup init --auto --recursive)"
38+
```
39+
40+
- To automatically run `phpup use` when a directory contains a `.php-version` file, add the `--auto`(long: `--auto-switch`) option.
41+
- To search recursively for a `.php-version` file in a parent directory when running `phpup use` automatically, add the `--recursive`(long: `--recursive-version-file`) option.
42+
- For more options, run `phpup init --help`.
43+
44+
## Usage
45+
46+
```
47+
phpup help
2148
```
2249

23-
## :hammer: Usage
50+
## Contribution
2451

25-
## :pencil2: Contribution
52+
PRs Welcome :tada:
2653

2754
- [TODO.md](TODO.md)
2855

29-
## :paperclip: Inspired
56+
## Inspired
3057

3158
- [Schniz/fnm](https://github.com/Schniz/fnm)
3259
- [TaKO8Ki/frum](https://github.com/TaKO8Ki/frum)

0 commit comments

Comments
 (0)