Adding example usage to README

jgivoni · Aug 31, 2023 · 8ae9326 · 8ae9326
1 parent 51bf240
commit 8ae9326
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,3 +16,13 @@ It supports Flysystem v3 and is currently maintained, which makes it superior to
 ```bash
 composer require jgivoni/flysystem-cache-adapter
 ```
+
+## Example usage
+
+```php
+$cache = new \Symfony\Component\Cache\Adapter\RedisAdapter(...);
+
+$filesystemAdapter = new \League\Flysystem\AwsS3V3\AwsS3V3Adapter(...);
+
+$cachedFilesystemAdapter = new \jgivon\Flysysten\Cache\CacheAdapter($filesystemAdapter, $cache);
+```