Skip to content

Commit ff77b51

Browse files
committed
Refactor README.MD to update installation instructions and remove unnecessary code
1 parent a82458d commit ff77b51

File tree

1 file changed

+4
-82
lines changed

1 file changed

+4
-82
lines changed

README.MD

Lines changed: 4 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,6 @@
77
[![Build](https://github.com/Thavarshan/phpvm/actions/workflows/use.yml/badge.svg?label=build&branch=main)](https://github.com/Thavarshan/phpvm/actions/workflows/use.yml)
88
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
99

10-
## Table of Contents
11-
12-
- [Introduction](#introduction)
13-
- [About phpvm](#about-phpvm)
14-
- [Installation](#installation)
15-
- [Install & Update Script](#install--update-script)
16-
- [Verify Installation](#verify-installation)
17-
- [Manual Install](#manual-install)
18-
- [Manual Update](#manual-update)
19-
- [Usage](#usage)
20-
- [Installing PHP Versions](#installing-php-versions)
21-
- [Switching PHP Versions](#switching-php-versions)
22-
- [Uninstalling PHP Versions](#uninstalling-php-versions)
23-
- [Listing Installed Versions](#listing-installed-versions)
24-
- [Default Version](#default-version)
25-
- [System PHP Version](#system-php-version)
26-
- [Using a Mirror](#using-a-mirror)
27-
- [Running Tests](#running-tests)
28-
- [Uninstallation](#uninstallation)
29-
- [Troubleshooting](#troubleshooting)
30-
- [Maintainers](#maintainers)
31-
- [License](#license)
32-
- [Disclaimer](#disclaimer)
33-
3410
## Introduction
3511

3612
`phpvm` is a PHP Version Manager that allows you to easily install, switch between, and manage multiple PHP versions via the command line.
@@ -46,10 +22,6 @@ $ phpvm use 8.0
4622
Now using PHP v8.0.8
4723
$ php -v
4824
PHP 8.0.8
49-
$ phpvm install 8.1
50-
Now using PHP v8.1.1
51-
$ php -v
52-
PHP 8.1.1
5325
```
5426

5527
## About phpvm
@@ -59,11 +31,9 @@ PHP 8.1.1
5931
### Key Features
6032

6133
- Install and use different PHP versions.
62-
- Easily switch between PHP versions.
63-
- Manage global PHP settings and extensions.
64-
- Install PHP versions via package managers like `apt` or `brew`, or from source.
65-
- Auto-detect `.phpvmrc` files to switch PHP versions based on project configuration.
66-
- Supports Homebrew and Linux package managers, or installation from source for more advanced setups.
34+
- Easily switch between installed PHP versions.
35+
- List installed PHP versions.
36+
- Uninstall a specific PHP version.
6737

6838
## Installation
6939

@@ -131,11 +101,7 @@ To install a specific version of PHP, run:
131101
phpvm install 8.1
132102
```
133103

134-
This will install PHP version 8.1. You can also install PHP using a package manager:
135-
136-
```sh
137-
phpvm install --package-manager 7.4
138-
```
104+
This will install PHP version 8.1.
139105

140106
### Switching PHP Versions
141107

@@ -171,46 +137,6 @@ phpvm list
171137

172138
This will display all the PHP versions managed by `phpvm`.
173139

174-
### Default Version
175-
176-
To set the default PHP version for new shells, use:
177-
178-
```sh
179-
phpvm alias default 8.0
180-
```
181-
182-
This will ensure that PHP 8.0 is used as the default version whenever a new shell is opened.
183-
184-
### System PHP Version
185-
186-
To use the system-installed version of PHP:
187-
188-
```sh
189-
phpvm use system
190-
```
191-
192-
### Using a Mirror
193-
194-
To use a mirror of PHP binaries, set the `PHPVM_MIRROR` environment variable:
195-
196-
```sh
197-
export PHPVM_MIRROR=https://php-mirror-url.com
198-
phpvm install 8.0
199-
```
200-
201-
### Auto-Switch PHP Version Using `.phpvmrc`
202-
203-
If a `.phpvmrc` file is present in the directory, `phpvm` will automatically switch to the PHP version specified in the file. This allows seamless version switching when working on different projects that require different PHP versions.
204-
205-
To set up the `.phpvmrc` file for your project, create a file with the following content:
206-
207-
```sh
208-
# .phpvmrc
209-
8.0.8
210-
```
211-
212-
When navigating to a directory with this file, `phpvm` will automatically switch to the specified PHP version.
213-
214140
## Running Tests
215141

216142
You can run tests using Jest. Install the dependencies and run the following command:
@@ -259,7 +185,3 @@ This project is licensed under the MIT License. See [LICENSE](./LICENSE) for mor
259185
`phpvm` is an open-source tool designed to simplify PHP version management. While we strive to ensure its functionality across different platforms and configurations, we make no warranties or guarantees regarding its accuracy, completeness, reliability, or suitability for any particular purpose.
260186

261187
**Use at your own risk.** By using `phpvm`, you acknowledge that the developers and contributors are not responsible for any damages or data loss resulting from the installation, configuration, or use of this tool.
262-
263-
We recommend reviewing the source code, running tests, and using the tool in a controlled environment before deploying it in production settings. Contributions are always welcome, but please ensure any changes are well-tested and follow best practices.
264-
265-
If you encounter issues or need assistance, please open an issue on our GitHub repository, but note that support is offered as time and resources allow.

0 commit comments

Comments
 (0)