From 2628a47c761390afa5f175a5d57dacc3e0d3190d Mon Sep 17 00:00:00 2001 From: Vladimir Protsenko Date: Fri, 15 Oct 2021 04:15:28 +0300 Subject: [PATCH] Add readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e51381b --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Digitalocean API shell +Console utility for working with DigitalOcean API + +### Requirements +* PHP 7.4+ +* [Composer](https://getcomposer.org) +* PHP [Curl](https://www.php.net/manual/book.curl.php) extension +* PHP [GMP](https://www.php.net/manual/book.gmp.php) extension +* PHP [JSON](https://www.php.net/manual/book.json.php) extension + +### Installation +* Run `composer create-project grayfolk/digitalocean-api-shell`. +* Go to `digitalocean-api-shell` folder and edit `accounts.json`. This is a simple [JSON](https://www.json.org) file with `"username" : "API Key"` records. You can use whatever name is convenient for you (but it shoud be unique) and real DigitalOcean API key. You can obtain API key in your [DigitalOcean Account - API - Personal access tokens - Generate New Token](https://cloud.digitalocean.com/account/api/tokens/new). + +### Running +Go to `digitalocean-api-shell` folder and run `./do`.