Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nilsbehlen authored Mar 2, 2022
1 parent 9e182b4 commit c72f812
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
## This is the privacyIDEA PHP Client
## privacyIDEA PHP Client

This library will help you to connect your plugin to the privacyIDEA server using REST APIs.
This project is intended to ease the use of the privacyIDEA server REST API.

## Requirements

To use our client lib you have to install curl on your machine. If you have installed our client
with Composer you don't need to think about it, because Composer will do it for you automatically.
To avoid bugs we also advise you to install PHP >=7.3.
Curl is required for this project to work. If this project is installed using composer, curl is installed automatically.
A PHP Version >=7.3 is preferred.

## Connecting & Composer
## Composer

You can add our library to your repository as a submodule or install it using Composer.

To install our repository with Composer, run this command in Terminal:
To install with Composer, run the following command:

`composer require privacyidea/privacyidea-php-client`

Next, you have to run:
then:

`composer update`

You can also decide which version of our package you want to install.
For more information read the Composer documentation.

To install Composer follow this link:
https://getcomposer.org/doc/00-intro.md

Required Composer version is >=2.0.

0 comments on commit c72f812

Please sign in to comment.