From 27cb77325e25c34a2071d5fd5d9630e6f4257069 Mon Sep 17 00:00:00 2001 From: LeoAdamek Date: Tue, 12 Oct 2021 15:21:50 +0100 Subject: [PATCH] Add README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ed84c1e --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +Tigerbay PHP +============ + + + +Usage +----- + +### Initialize The Client +~~~php +use Mrzen\Tigerbay; + +$config = (new Tigerbay\Config())->setBaseURL($baseURL) // Required + ->setClientId($clientId) // Required + ->setSecret($clientSecret) // Required + ->setTimeout(10.0) // Optional + +$client = new Tigerbay\Client($config); + +// Get cache stats + +$stats = $client->stats(); + +echo 'System contains ' . $stats->getItemCount() . ' tours'; +~~~