Skip to content
This repository has been archived by the owner on Sep 16, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ericwang401 committed Jul 22, 2022
1 parent b10a05e commit 04c2b45
Showing 1 changed file with 8 additions and 26 deletions.
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,18 @@
# ProxmoxVE API
This **PHP 8+** Proxmox library allow, to interact with your Proxmox PVE server and cluster via API.
# Proxmox API
This **PHP 8+** Proxmox library allows you to interact with your Proxmox PVE server and cluster in an object-oriented way.

[![Latest Stable Version](https://poser.pugx.org/mrkampf/proxmox-ve/v/stable)](https://packagist.org/packages/mrkampf/proxmox-ve)
[![Total Downloads](https://poser.pugx.org/mrkampf/proxmox-ve/downloads)](https://packagist.org/packages/mrkampf/proxmox-ve)
[![Latest Unstable Version](https://poser.pugx.org/mrkampf/proxmox-ve/v/unstable)](https://packagist.org/packages/mrkampf/proxmox-ve)
[![License](https://poser.pugx.org/mrkampf/proxmox-ve/license)](https://packagist.org/packages/mrkampf/proxmox-ve)
This library is a fork of another library, and this library is actively maintained as it's being used in a real project.

> You find any errors, typos or you detect that something is not working as expected please open an [issue](https://github.com/MrKampf/proxmoxVE/issues/new). I'll try to release a fix asap.
[![Latest Stable Version](http://poser.pugx.org/performave/proxmox/v)](https://packagist.org/packages/performave/proxmox) [![Total Downloads](http://poser.pugx.org/performave/proxmox/downloads)](https://packagist.org/packages/performave/proxmox) [![Latest Unstable Version](http://poser.pugx.org/performave/proxmox/v/unstable)](https://packagist.org/packages/performave/proxmox) [![License](http://poser.pugx.org/performave/proxmox/license)](https://packagist.org/packages/performave/proxmox) [![PHP Version Require](http://poser.pugx.org/performave/proxmox/require/php)](https://packagist.org/packages/performave/proxmox)

## Getting Started

Recommended installation is using **Composer**, if you do not have **Composer** what are you waiting?

In the root of your project execute the following:

```sh
$ composer require mrkampf/proxmox-ve
```
> If you find any errors, typos, or errors [issue](https://github.com/performave/proxmox/issues/new). I'll try to release a hotfix
Or add this to your `composer.json` file:
## Getting Started

```json
{
"require": {
"mrkampf/proxmox-ve": "^0.4.0"
}
}
```
Install using Composer via the command-line

Then perform the installation:
```sh
$ composer install --no-dev
$ composer require performave/proxmox
```

## Example
Expand Down

0 comments on commit 04c2b45

Please sign in to comment.