Skip to content

Commit 44e0dc4

Browse files
committed
Prepare 2.0 release
1 parent 6177ba2 commit 44e0dc4

5 files changed

Lines changed: 29 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,12 @@ library into Symfony applications.
1212
It provides an efficient abstraction for the filesystem in order to change the storage backend depending
1313
on the execution environment (local files in development, cloud storage in production and memory in tests).
1414

15+
> Note: you are reading the documentation for flysystem-bundle 2.0, which relies on Flysystem 2.X.
16+
> If you use Flysystem 1.X, use [flysystem-bundle 1.X](https://github.com/thephpleague/flysystem-bundle/tree/1.x).
17+
1518
## Installation
1619

17-
flysystem-bundle requires PHP 7.1+ and Symfony 4.2+.
20+
flysystem-bundle requires PHP 7.2+ and Symfony 4.2+.
1821

1922
You can install the bundle using Symfony Flex:
2023

@@ -93,14 +96,16 @@ to interact with your storage.
9396

9497
## Full documentation
9598

96-
1. [Getting started](https://flysystem.thephpleague.com/v2/docs/getting-started/)
99+
1. [Getting started](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/1-getting-started.md)
97100
2. Cloud storage providers:
98101
[AsyncAws S3](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#asyncaws-s3),
99-
[AWS S3](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#aws-s3),
100-
[Google Cloud Storage](https://flysystem.thephpleague.com/v2/docs/adapter/gcs/),
102+
[AWS SDK S3](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#aws-sdk-s3),
103+
[Google Cloud Storage](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#google-cloud-storage),
104+
[DigitalOcean Spaces](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#digitalocean-spaces),
105+
[Scaleway Object Storage](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#scaleway-object-storage)
101106
3. [Interacting with FTP and SFTP servers](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/3-interacting-with-ftp-and-sftp-servers.md)
102-
4. [Using a lazy adapter to switch storage backend using an environment variable](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/5-using-lazy-adapter-to-switch-at-runtime.md)
103-
5. [Creating a custom adapter](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/6-creating-a-custom-adapter.md)
107+
4. [Using a lazy adapter to switch storage backend using an environment variable](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/4-using-lazy-adapter-to-switch-at-runtime.md)
108+
5. [Creating a custom adapter](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/5-creating-a-custom-adapter.md)
104109

105110
* [Security issue disclosure procedure](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/A-security-disclosure-procedure.md)
106111
* [Configuration reference](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/B-configuration-reference.md)

UPGRADE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Upgrading from 1.0 to 2.0
2+
3+
flysystem-bundle 2.0 introduces Backward Compatibility breaks, meaning you will need to update
4+
the code of your projects to upgrade.
5+
6+
flysystem-bundle 2.0 relies on Flysystem 2.0, which introduced most of the backward incompatible
7+
changes. You should read
8+
[Flysystem 2.0 upgrade guide](https://flysystem.thephpleague.com/v2/docs/advanced/upgrade-to-2.0.0/).
9+
10+
In addition to the library updates, the bundle also changed a bit:
11+
12+
* Following the drop of support for several Cloud providers in Flysystem itself, the bundle no longer
13+
natively supports Azure, Dropbox, Rackspace and WebDAV. If the need arise for community adapters to be
14+
ported to Flysystem 2 and flysystem-bundle 2, we could add them again.
15+
* Following their removal from the main library, null, cache, zip and replicate adapters were removed
16+
from the bundle as well.
17+
* Following the drop of support for plugins in the main library, the bundle does not support them anymore.

docs/2-cloud-storage-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ flysystem:
3333
prefix: 'optional/path/prefix'
3434
```
3535
36-
## AWS S3
36+
## AWS SDK S3
3737
3838
### Installation
3939
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)