diff --git a/README.md b/README.md index df57d723..6eb4a36a 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ Acquia PHP SDK for CloudAPI v2 [![Latest Stable Version](https://poser.pugx.org/typhonius/acquia-php-sdk-v2/v/stable.png)](https://packagist.org/packages/typhonius/acquia-php-sdk-v2) [![Latest Unstable Version](https://poser.pugx.org/typhonius/acquia-php-sdk-v2/v/unstable.png)](https://packagist.org/packages/typhonius/acquia-php-sdk-v2) -With the [original Acquia Cloud SDK](https://github.com/acquia/acquia-sdk-php) being deprecated and a [new version of Cloud API](https://cloud.acquia.com/api-docs/) being made available, this SDK aims to fill the gap and use more modern PHP packages to allow developers to continue to build tools that interact with the Acquia Cloud API. +This library provides the capability to develop tooling which integrates with the[new version (2.0) of Cloud API](https://cloud.acquia.com/api-docs/). + +The [original Acquia Cloud SDK](https://github.com/acquia/acquia-sdk-php) has been deprecated so build tools requiring modern PHP versions and packages should use this library. ## Installation @@ -80,6 +82,10 @@ $backup->create($environmentUuid, $dbName); ``` +## Documentation + +Documentation of each of the classes and methods has been automatically generated by phpDocumentor and exists in the `gh-pages` branch. [This is available for browsing on GitHub](https://typhonius.github.io/acquia-php-sdk-v2/). + ## I just want to talk to the API without having to write code The [Acquia Cli Robo application](https://github.com/typhonius/acquia_cli) creates a command line tool for communicating with the API using this SDK. Its purpose is to provide a simple mechanism for interacting with the API without having to write a line of code.