Skip to content

Commit

Permalink
Adds documentation link to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
typhonius committed Dec 26, 2019
1 parent 7dda1bc commit 52f35c5
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 52f35c5

Please sign in to comment.