Moved readme info to docs

Author: dabeeeenster

README.md

@@ -6,146 +6,6 @@
 
 The SDK for PHP applications for [https://www.flagsmith.com/](https://www.flagsmith.com/).
 
-## Installation
-
-`composer require flagsmith/flagsmith-php-client`
-
-Requires PHP 7.4 or newer and ships with GuzzleHTTP.
-
-You can optionally provide your own implementation of PSR-18 and PSR-16
-
-> You will also need some implementation of [PSR-18](https://packagist.org/providers/psr/http-client-implementation)
-> and [PSR-17](https://packagist.org/providers/psr/http-factory-implementation), for example
-> [Guzzle](https://packagist.org/packages/guzzlehttp/guzzle)
-> and [PSR-16](https://packagist.org/providers/psr/simple-cache-implementation), for example
-> [Symfony Cache](https://packagist.org/packages/symfony/cache).
-> Example:
-
-`composer require flagsmith/flagsmith-php-client guzzlehttp/guzzle symfony/cache`
-
-or
-
-`composer require flagsmith/flagsmith-php-client symfony/http-client nyholm/psr7 symfony/cache`
-
-## Usage
-
-The Flagsmith PHP Client is utilized in such a way that makes it immutable. Everytime you change or set a setting the client will return a clone of itself.
-
-```php
-$flagsmith = new Flagsmith('apiToken');
-$flagsmithWithCache = $flagsmith->withCache(/** PSR-16 Cache Interface  **/);
-```
-
-If you are self hosting an instance of Flagsmith you can set that as the second parameter of the Flagsmith Class, make sure to include the full path
-
-```php
-$flagsmith = new Flagsmith('apiToken', 'https://api.flagsmith.com/api/v1/');
-```
-
-### Utilizing Cache
-
-```php
-$flagsmith = new Flagsmith('apiToken');
-$flagsmithWithCache = $flagsmith
-  ->withCache(/** PSR-16 Cache Interface  **/)
-  ->withTimeToLive(15); //15 seconds
-```
-
-### Get all Flags
-
-Get All feature flags. The flags will be returned as a `Flagsmith\Models\Flag` model
-
-#### Globally
-
-```php
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFlags();
-```
-
-#### By Identity
-
-```php
-$identity = new \Flagsmith\Models\Identity('identity');
-
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFlagsByIdentity($identity);
-```
-
-### Get Individual Flag
-
-The Individual flag will be returned as a `Flagsmith\Models\Flag` model
-
-#### Globally
-
-```php
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFlag('name');
-```
-
-#### By Identity
-
-```php
-$identity = new \Flagsmith\Models\Identity('identity');
-
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFlagByIdentity($identity, 'name');
-```
-
-### Check if Feature is Enabled
-
-Check if a feature is enabled or not
-
-#### Globally
-
-```php
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->isFeatureEnabled('name');
-```
-
-#### By Identity
-
-```php
-$identity = new \Flagsmith\Models\Identity('identity');
-
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->isFeatureEnabledByIdentity($identity, 'name');
-```
-
-### Get Feature Value
-
-Get the value of a feature
-
-#### Globally
-
-```php
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFeatureValue('name', 'default value');
-```
-
-#### By Identity
-
-```php
-$identity = new \Flagsmith\Models\Identity('identity');
-
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFeatureValueByIdentity($identity, 'name', 'default value');
-```
-
-### Utilizing Identity Traits
-
-You can optionally declare traits against the identity model
-
-```php
-$identity = new \Flagsmith\Models\Identity('identity');
-
-$identityTrait = (new \Flagsmith\Models\IdentityTrait('Foo'))->withValue('Bar');
-
-$identity->withTrait($identityTrait);
-
-$flagsmith = new \Flagsmith\Flagsmith('apiToken');
-$flagsmith->getFlagsByIdentity($identity);
-```
-
 ## Adding to your project
 
 For full documentation visit [https://docs.flagsmith.com/clients/php/](https://docs.flagsmith.com/clients/php/)