add requirements, update readme

zestic · Oct 17, 2021 · a4cceee · a4cceee
1 parent 6c9e4c2
commit a4cceee
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
 # Flysystem2 Component
+
+## Install
+```bash
+composer require zestic/flysystem2-component
+```
+## Set Up
+
+### Filesystem
+
+In .env
+```bash
+FLYSYSTEM_NAME_ADAPTER=AwsS3V3
+FLYSYSTEM_NAME_BUCKET=bucket
+FLYSYSTEM_NAME_ENDPOINT=https://us-east-1.aws.com
+FLYSYSTEM_NAME_KEY=
+FLYSYSTEM_NAME_REGION=us-east-1
+FLYSYSTEM_NAME_SECRET=
+FLYSYSTEM_NAME_VISIBILITY=public
+```
diff --git a/composer.json b/composer.json
@@ -13,7 +13,8 @@
   "require": {
     "php": "^8.0",
     "iampersistent/config-value-component": "^1.1",
-    "league/flysystem": "^2.0"
+    "league/flysystem": "^2.0",
+    "symfony/dotenv": "6.0.x-dev"
   },
   "require-dev": {
     "codeception/codeception": "^4.1.6",