diff --git a/README.md b/README.md index d560c1a4c1a1cd96a6e3029c78e1e24120268866..23eb9bfa3c142796668670f24e4fc925fb441413 100644 --- a/README.md +++ b/README.md @@ -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.