diff --git a/README.md b/README.md index 751b1b81..7b8015e3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ +[![Latest Stable Version](https://poser.pugx.org/mautic/api-library/v)](//packagist.org/packages/mautic/api-library) [![Total Downloads](https://poser.pugx.org/mautic/api-library/downloads)](//packagist.org/packages/mautic/api-library) [![Latest Unstable Version](https://poser.pugx.org/mautic/api-library/v/unstable)](//packagist.org/packages/mautic/api-library) [![License](https://poser.pugx.org/mautic/api-library/license)](//packagist.org/packages/mautic/api-library) + # Using the Mautic API Library ## Requirements * PHP 7.2 or newer * cURL support +## Installing the API Library +You can install the API Library with the following command: + +```bash +composer require mautic/api-library +``` + ## Mautic Setup The API must be enabled in Mautic. Within Mautic, go to the Configuration page (located in the Settings menu) and under API Settings enable Mautic's API. If you intend on using Basic Authentication, ensure you enable it. You can also choose which OAuth protocol to use here. After saving the configuration, go to the API Credentials page