From a9c8bc8f30dd097ce465482604f787d7e8f3a349 Mon Sep 17 00:00:00 2001 From: David Date: Sat, 11 Aug 2018 21:12:59 +0100 Subject: [PATCH] init details --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index e69de29..790dd5d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,17 @@ +# CloudBrowserCo - Screenshot and PDF API +A lightweight wrapper written in PHP for the rendering and export APIs provided by CloudBrowserCo (cloudbrowser.co). + +## Install +The package is PSR-4 compliant, either use a package manager or a standards compliant autoloader (like the one included in the examples directory). + +Via composer: +`composer require cloudbrowser/adapter` + + +## Requirements + + API KEY (obtain your free key from https://cloudbrowser.co/register) + + PHP 5.3+ + + CURL + +# Notes +We have chosen to not make use of exceptions for error communication due to their impact on speed of code execution and relative difficulty for beginners.